gate.rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97a150ad280b246d59dce0e7e011ae8faeaf9f3c743b726ae931a7353457e5b3
-  data.tar.gz: a530909743923390245e633b04703c81fe9d78d10387118c959cea4d59a94e41
+  metadata.gz: af5b0afadf1a2aba9eba70064c5fc2503477d45569d27a5cfacfe0798d1ea3f0
+  data.tar.gz: 4c9cd963ac62156e5e0ae6c1b73c50c82c13cbeaacd15ed8c6ab657bcd5dfe50
 SHA512:
-  metadata.gz: e05641f6589dd90c24b86779b8845309da739e3fc662712c43b9ac49c00abd0097a45b17f77378ef94d943566da09b03519792e5b9d965d9e7ac953bdc6bd252
-  data.tar.gz: a40ba066ccc2aeeea27067601a0d91bd5f41ac5c5843c599efa58c69bd5b71bde598fec6979efdab6582d8ff634d1c02aa815d0de91050425ff90ef685e35cf4
+  metadata.gz: ced56131ac508a3cbb25b6cdb14f1e0382b7d91bf57bcecd452169158daee8f595dddabeb3ef820aaedb47362348a4613c69c76f2d5f9c4d69b47ac8a30488ca
+  data.tar.gz: 3aab85b7ba081c0de10770cf8123e22358bd84d66524f1dc3a7f156dd1589e1219ae2a296484710ac0df59ad60da0c94e32f64b0e232d4a3a243b5c180201289

data/gate.rb.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.name = 'gate.rb'
 
   spec.version = Gate::VERSION
-  spec.date = '2025-07-14'
+  spec.date = '2025-07-17'
 
   spec.summary = "Access the Gate API with Ruby."
   spec.description = "Access the Gate API with Ruby."

data/lib/Gate/Configuration.rb

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

data/lib/Gate/Error.rb

@@ -27,4 +27,5 @@ module Gate
   class InvalidRequestError < Error; end
   class NetworkError < Error; end
   class RateLimitError < Error; end
+  class InsufficientPermissionError < Error; end
 end

data/lib/Gate/V4/Client.rb

@@ -120,6 +120,13 @@ module Gate
         handle_response(response)
       end
 
+      # Private endpoints
+
+      def wallet_total_balance(currency: nil)
+        response = get(path: '/wallet/total_balance', args: {currency: currency})
+        handle_response(response)
+      end
+
       def spot_orders(
         text: nil,
         currency_pair:,
@@ -149,20 +156,63 @@ module Gate
         handle_response(response)
       end
 
+      def spot_my_trades(
+        currency_pair: nil,
+        limit: nil,
+        page: nil,
+        order_id: nil,
+        account: nil,
+        from: nil,
+        to: nil
+      )
+        args = {
+          currency_pair: currency_pair,
+          limit: limit,
+          page: page,
+          order_id: order_id,
+          account: account,
+          from: from,
+          to: to
+        }.reject{|k,v| v.nil?}.stringify_values
+        response = get(
+          path: '/spot/my_trades',
+          args: args
+        )
+        handle_response(response)
+      end
+
       private
 
-      def initialize(api_key:, api_secret:)
-        @api_key = api_key.encode('UTF-8')
-        @api_secret = api_secret.encode('UTF-8')
+      def initialize(api_key: nil, api_secret: nil, configuration: nil)
+        @api_key = (api_key || configuration&.api_key || Gate.configuration.api_key).encode('UTF-8')
+        @api_secret = (api_secret || configuration&.api_secret || Gate.configuration.api_secret).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))
+      def query_string(verb:, args:)
+        case verb
+        when 'GET'
+          args.x_www_form_urlencode
+        when 'POST'
+          nil
+        else
+          raise "The verb, #{verb}, is not acceptable."
+        end
+      end
+
+      def encoded_payload(verb:, args:)
+        case verb
+        when 'GET'
+          OpenSSL::Digest::SHA512.hexdigest('')
+        when 'POST'
+          args.reject!{|k,v| v.nil?}
+          OpenSSL::Digest::SHA512.hexdigest(JSON.dump(args))
+        else
+          raise "The verb, #{verb}, is not acceptable."
+        end
       end
 
       def timestamp
@@ -170,17 +220,13 @@ module Gate
       end
 
       def message(verb:, path:, args:)
-        query_string = (
-          case verb
-          when 'GET'
-            args.x_www_form_urlencode
-          when 'POST'
-            nil
-          else
-            raise "The verb, #{verb}, is not acceptable."
-          end
-        )
-        [verb, full_path(path), query_string, encoded_payload(args), timestamp].join("\n")
+        [
+          verb,
+          full_path(path),
+          query_string(verb: verb, args: args),
+          encoded_payload(verb: verb, args: args),
+          timestamp
+        ].join("\n")
       end
 
       def signature(message)
@@ -234,6 +280,12 @@ module Gate
               message: response.message,
               body: response.body
             )
+          when 403
+            raise Gate::InsufficientPermissionError.new(
+              code: response.code,
+              message: response.message,
+              body: response.body
+            )
           when 429
             raise Gate::RateLimitError.new(
               code: response.code,

data/lib/Gate/VERSION.rb

@@ -2,5 +2,5 @@
 # Gate::VERSION
 
 module Gate
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/gate.rb

@@ -6,4 +6,5 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 module Gate; end
 
 require 'Gate/Client'
+require 'Gate/Configuration'
 require 'Gate/VERSION'

data/test/Gate/Configuration_test.rb

@@ -0,0 +1,13 @@
+require_relative '../helper'
+
+describe Gate::Configuration do
+  describe "#initialize" do
+    it "sets default values" do
+      config = Gate::Configuration.new
+      _(config.api_base_url).to eq('https://api.gateio.ws')
+      _(config.debug).to eq(false)
+      _(config.api_key).must_equal(nil)
+      _(config.api_secret).must_equal(nil)
+    end
+  end
+end

data/test/Gate/V4/Client/test_private_endpoints.rb

@@ -11,6 +11,57 @@ describe Gate::V4::Client do
     )
   end
 
+  describe "#wallet_total_balance" do
+    let(:amount){0.0001}
+    let(:price){100_000}
+    let(:side){'buy'}
+
+    context "success" do
+      it "fetches my wallet balance for a specific market" do
+        VCR.use_cassette('v4/wallet/total_balance') do
+          response = subject.wallet_total_balance(currency: 'BTC')
+          _(response).must_be_kind_of(Hash)
+          assert(response['details'])
+          assert(response['details']['delivery'])
+          _(response['details']['delivery']['currency']).must_equal('BTC')
+          _(response['details']['delivery']['amount']).must_equal('0')
+          assert(response['details']['finance'])
+          _(response['details']['finance']['currency']).must_equal('BTC')
+          _(response['details']['finance']['amount']).must_equal('0')
+          assert(response['details']['futures'])
+          _(response['details']['futures']['currency']).must_equal('BTC')
+          _(response['details']['futures']['amount']).must_equal('0')
+        end
+      end
+    end
+
+    context "invalid key" do
+      let(:api_key){'invalid_key'}
+      let(:api_secret){'invalid_secret'}
+
+      it "raises an error" do
+        VCR.use_cassette('v4/wallet/total_balance_with_an_invalid_key') do
+          assert_raises do
+            subject.wallet_total_balance(currency: 'BTC')
+          end
+        end
+      end
+    end
+
+    context "insufficient permission" do
+      let(:api_key){'key_with_insufficient_permission'}
+      let(:api_secret){'secret_with_insufficient_permission'}
+
+      it "raises an error" do
+        VCR.use_cassette('v4/wallet/total_balance_with_insufficient_permission') do
+          assert_raises do
+            subject.spot_orders(currency: 'BTC')
+          end
+        end
+      end
+    end
+  end
+
   describe "#spot_orders" do
     let(:amount){0.0001}
     let(:price){100_000}
@@ -31,7 +82,10 @@ describe Gate::V4::Client do
     end
 
     context "invalid key" do
-      it "fetches my orders for a specific market" do
+      let(:api_key){'invalid_key'}
+      let(:api_secret){'invalid_secret'}
+
+      it "raises an error" do
         VCR.use_cassette('v4/spot/orders_with_an_invalid_key') do
           assert_raises do
             subject.spot_orders(currency_pair: 'BTC_USDT', side: side, amount: amount, time_in_force: 'gtc', price: price)
@@ -39,5 +93,49 @@ describe Gate::V4::Client do
         end
       end
     end
+
+    context "insufficient permission" do
+      let(:api_key){'key_with_insufficient_permission'}
+      let(:api_secret){'secret_with_insufficient_permission'}
+
+      it "raises an error" do
+        VCR.use_cassette('v4/spot/orders_with_insufficient_permission') do
+          assert_raises do
+            subject.spot_orders(currency_pair: 'BTC_USDT', side: side, amount: amount, time_in_force: 'gtc', price: price)
+          end
+        end
+      end
+    end
+  end
+
+  describe "#spot_my_trades" do
+    context "success" do
+      it "fetches my trading history" do
+        VCR.use_cassette('v4/spot/my_trades') do
+          response = subject.spot_my_trades(currency_pair: 'BTC5S_USDT')
+          _(response).must_be_kind_of(Array)
+          _(response.first).must_be_kind_of(Hash)
+          assert(response.first['id'])
+          assert(response.first['create_time'])
+          assert(response.first['currency_pair'])
+          assert(response.first['amount'])
+          assert(response.first['price'])
+          assert(['buy', 'sell'].include?(response.first['side']))
+        end
+      end
+    end
+
+    context "invalid key" do
+      let(:api_key){'invalid_key'}
+      let(:api_secret){'invalid_secret'}
+
+      it "raises an error" do
+        VCR.use_cassette('v4/spot/my_trades_with_an_invalid_key') do
+          assert_raises do
+            subject.spot_my_trades(currency_pair: 'BTC_USDT')
+          end
+        end
+      end
+    end
   end
 end

data/test/helper.rb

@@ -9,18 +9,17 @@ require 'gate'
 
 VCR.configure do |config|
   config.cassette_library_dir = 'test/fixtures/vcr_cassettes'
-
   config.hook_into :webmock
 
   config.filter_sensitive_data('<API_KEY>'){ENV['GATE_API_KEY']}
-  config.filter_sensitive_data('<API_SECRET>'){ENV['GATE_API_SECRET'] }
+  config.filter_sensitive_data('<API_SECRET>'){ENV['GATE_API_SECRET']}
 
   # Allow localhost connections for debugging
   config.ignore_localhost = true
 
   config.default_cassette_options = {
     record: :new_episodes,
-    match_requests_on: [:method, :uri]
+    match_requests_on: [:method, :uri, :body]
   }
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gate.rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - thoran
 bindir: bin
 cert_chain: []
-date: 2025-07-14 00:00:00.000000000 Z
+date: 2025-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http.rb
@@ -33,6 +33,7 @@ files:
 - README.md
 - gate.rb.gemspec
 - lib/Gate/Client.rb
+- lib/Gate/Configuration.rb
 - lib/Gate/Error.rb
 - lib/Gate/V4/Client.rb
 - lib/Gate/VERSION.rb
@@ -41,6 +42,7 @@ files:
 - lib/Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode.rb
 - lib/Thoran/String/UrlEncode/url_encode.rb
 - lib/gate.rb
+- test/Gate/Configuration_test.rb
 - test/Gate/V4/Client/test_private_endpoints.rb
 - test/Gate/V4/Client/test_public_endpoints.rb
 - test/helper.rb