Add CacheRateLimiter

Reviewed-on: #1

.github/workflows/dependabot-auto-merge.yml

@@ -14,7 +14,7 @@ jobs:
 
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v2.4.0
+        uses: dependabot/fetch-metadata@v2.5.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
 

.github/workflows/fix-php-code-style-issues.yml

@@ -23,6 +23,6 @@ jobs:
         uses: aglipanci/laravel-pint-action@2.6
 
       - name: Commit changes
-        uses: stefanzweifel/git-auto-commit-action@v6
+        uses: stefanzweifel/git-auto-commit-action@v7
         with:
           commit_message: Fix styling

.github/workflows/run-tests.yml

@@ -2,12 +2,9 @@ name: run-tests
 
 on:
   push:
-    paths:
-      - '**.php'
-      - '.github/workflows/run-tests.yml'
-      - 'phpunit.xml.dist'
-      - 'composer.json'
-      - 'composer.lock'
+    branches: [main, dev]
+  pull_request:
+    branches: [main]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -15,19 +12,20 @@ concurrency:
 
 jobs:
   test:
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     timeout-minutes: 5
     strategy:
       fail-fast: true
       matrix:
         os: [ubuntu-latest]
-        php: [8.4, 8.3]
+        php: [8.4]
         laravel: [12.*, 11.*]
         stability: [prefer-stable]
         include:
           - laravel: 12.*
+            testbench: 10.*
           - laravel: 11.*
-          - laravel: 10.*
+            testbench: 9.*
 
     name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 

README.md

@@ -2,10 +2,19 @@
 
 A Laravel package for interacting with the Bitunix cryptocurrency exchange API.
 
+---
+
+[![Latest Stable Version](https://poser.pugx.org/mahdimsr/laravel-bitunix-api/v/stable)](https://packagist.org/packages/msr/laravel-bitunix-api)
+[![Fix PHP code style issues](https://github.com/mahdimsr/laravel-bitunix-api/actions/workflows/fix-php-code-style-issues.yml/badge.svg)](https://github.com/mahdimsr/laravel-bitunix-api/actions/workflows/fix-php-code-style-issues.yml)
+[![PHPStan](https://github.com/mahdimsr/laravel-bitunix-api/actions/workflows/phpstan.yml/badge.svg)](https://github.com/mahdimsr/laravel-bitunix-api/actions/workflows/phpstan.yml)
+[![run-tests](https://github.com/mahdimsr/laravel-bitunix-api/actions/workflows/run-tests.yml/badge.svg)](https://github.com/mahdimsr/laravel-bitunix-api/actions/workflows/run-tests.yml)
+[![License](https://poser.pugx.org/mahdimsr/laravel-bitunix-api/license)](https://packagist.org/packages/msr/laravel-bitunix-api)
+
+
 ## Installation
 
 ```bash
-composer require msr/laravel-bitunix-api
+composer require mahdimsr/laravel-bitunix-api
 ```
 
 ## Configuration

composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "mahdimsr/laravel-bitunix-api",
+    "name": "moltox/laravel-bitunix-api",
     "description": "composer package for using bitunix api trading",
     "keywords": [
         "msr",
@@ -13,12 +13,17 @@
             "name": "mahdi mansouri",
             "email": "mahdi.msr4@gmail.com",
             "role": "Developer"
+        },
+        {
+            "name": "Maik Mueller   ",
+            "email": "mueller.maik1@gmail.com",
+            "role": "Developer"
         }
     ],
     "require": {
         "php": "^8.4",
         "spatie/laravel-package-tools": "^1.16",
-        "illuminate/contracts": "^11.0||^12.0||^10.0"
+        "illuminate/contracts": "^10.0||^11.0||^12.0||^13.0"
     },
     "require-dev": {
         "laravel/pint": "^1.14",
@@ -69,7 +74,7 @@
             }
         }
     },
-    "version": "1.0.0",
+    "version": "1.2.2",
     "minimum-stability": "stable",
     "prefer-stable": true
 }

src/Contracts/RateLimiterContract.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Msr\LaravelBitunixApi\Contracts;
+
+interface RateLimiterContract
+{
+    public function throttle(
+        string $bucket,
+        string $identity,
+        int $maxRequests,
+        float $perSeconds
+    ): void;
+}

src/LaravelBitunixApi.php

@@ -9,13 +9,14 @@ use Msr\LaravelBitunixApi\Requests\FlashClosePositionRequestContract;
 use Msr\LaravelBitunixApi\Requests\FutureKLineRequestContract;
 use Msr\LaravelBitunixApi\Requests\GetPendingPositionsRequestContract;
 use Msr\LaravelBitunixApi\Requests\GetSingleAccountRequestContract;
+use Msr\LaravelBitunixApi\Requests\GetTradingPairsRequestContract;
 use Msr\LaravelBitunixApi\Requests\Header;
 use Msr\LaravelBitunixApi\Requests\PlaceOrderRequestContract;
 use Msr\LaravelBitunixApi\Requests\PlacePositionTpSlOrderRequestContract;
 use Msr\LaravelBitunixApi\Requests\PlaceTpSlOrderRequestContract;
 use Psr\Http\Message\ResponseInterface;
 
-class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginModeRequestContract, FlashClosePositionRequestContract, FutureKLineRequestContract, GetPendingPositionsRequestContract, GetSingleAccountRequestContract, PlaceOrderRequestContract, PlacePositionTpSlOrderRequestContract, PlaceTpSlOrderRequestContract
+class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginModeRequestContract, FlashClosePositionRequestContract, FutureKLineRequestContract, GetPendingPositionsRequestContract, GetSingleAccountRequestContract, GetTradingPairsRequestContract, PlaceOrderRequestContract, PlacePositionTpSlOrderRequestContract, PlaceTpSlOrderRequestContract
 {
     private Client $publicFutureClient;
 
@@ -53,6 +54,21 @@ class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginMo
         return $response;
     }
 
+    public function getTradingPairs(?string $symbols = null): ResponseInterface
+    {
+        $queryParams = [];
+
+        if ($symbols !== null) {
+            $queryParams['symbols'] = $symbols;
+        }
+
+        $response = $this->publicFutureClient->get('trading_pairs', [
+            'query' => $queryParams,
+        ]);
+
+        return $response;
+    }
+
     public function changeLeverage(string $symbol, string $marginCoin, int $leverage): ResponseInterface
     {
         $body = [
@@ -289,10 +305,8 @@ class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginMo
             $body['slStopType'] = $slStopType;
         }
 
-        $response = $this->getPrivateFutureClient([], $body)->post('tpsl/position/place_order', [
+        return $this->getPrivateFutureClient([], $body)->post('tpsl/position/place_order', [
             'json' => $body,
         ]);
-
-        return $response;
     }
 }

src/LaravelBitunixApiServiceProvider.php

@@ -3,17 +3,21 @@
 namespace Msr\LaravelBitunixApi;
 
 use Msr\LaravelBitunixApi\Commands\LaravelBitunixApiCommand;
+use Msr\LaravelBitunixApi\Contracts\RateLimiterContract;
 use Msr\LaravelBitunixApi\Requests\ChangeLeverageRequestContract;
 use Msr\LaravelBitunixApi\Requests\ChangeMarginModeRequestContract;
 use Msr\LaravelBitunixApi\Requests\FlashClosePositionRequestContract;
 use Msr\LaravelBitunixApi\Requests\FutureKLineRequestContract;
 use Msr\LaravelBitunixApi\Requests\GetPendingPositionsRequestContract;
 use Msr\LaravelBitunixApi\Requests\GetSingleAccountRequestContract;
+use Msr\LaravelBitunixApi\Requests\GetTradingPairsRequestContract;
 use Msr\LaravelBitunixApi\Requests\PlaceOrderRequestContract;
 use Msr\LaravelBitunixApi\Requests\PlacePositionTpSlOrderRequestContract;
 use Msr\LaravelBitunixApi\Requests\PlaceTpSlOrderRequestContract;
+use Msr\LaravelBitunixApi\Support\CacheRateLimiter;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
+use Illuminate\Contracts\Cache\Factory as CacheFactory;
 
 class LaravelBitunixApiServiceProvider extends PackageServiceProvider
 {
@@ -45,5 +49,12 @@ class LaravelBitunixApiServiceProvider extends PackageServiceProvider
         $this->app->bind(GetSingleAccountRequestContract::class, LaravelBitunixApi::class);
         $this->app->bind(PlaceTpSlOrderRequestContract::class, LaravelBitunixApi::class);
         $this->app->bind(PlacePositionTpSlOrderRequestContract::class, LaravelBitunixApi::class);
+        $this->app->bind(GetTradingPairsRequestContract::class, LaravelBitunixApi::class);
+
+        $this->app->bind(RateLimiterContract::class, function ($app) {
+            return new CacheRateLimiter(
+                $app->make(CacheFactory::class)->store()
+            );
+        });
     }
 }

src/Requests/GetTradingPairsRequestContract.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Msr\LaravelBitunixApi\Requests;
+
+use Psr\Http\Message\ResponseInterface;
+
+interface GetTradingPairsRequestContract
+{
+    /**
+     * Get future trading pair details
+     *
+     * @param  string|null  $symbols  Trading pairs, comma-separated (e.g., "BTCUSDT,ETHUSDT,XRPUSDT")
+     */
+    public function getTradingPairs(?string $symbols = null): ResponseInterface;
+}

src/Support/CacheRateLimiter.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Msr\LaravelBitunixApi\Support;
+
+use Illuminate\Contracts\Cache\Repository;
+use Msr\LaravelBitunixApi\Contracts\RateLimiterContract;
+
+class CacheRateLimiter implements RateLimiterContract
+{
+    public function __construct(
+        protected Repository $cache,
+    ) {
+    }
+
+    public function throttle(
+        string $bucket,
+        string $identity,
+        int $maxRequests,
+        float $perSeconds
+    ): void {
+        if ($maxRequests <= 0 || $perSeconds <= 0) {
+            return;
+        }
+
+        $cacheKey = $this->makeCacheKey($bucket, $identity);
+        $minIntervalMicroseconds = (int) (($perSeconds / $maxRequests) * 1_000_000);
+
+        $lastRequestAt = $this->cache->get($cacheKey);
+
+        if (is_numeric($lastRequestAt)) {
+            $elapsedMicroseconds = (int) ((microtime(true) - (float) $lastRequestAt) * 1_000_000);
+
+            if ($elapsedMicroseconds < $minIntervalMicroseconds) {
+                $sleepMicroseconds = $minIntervalMicroseconds - $elapsedMicroseconds;
+
+                if ($sleepMicroseconds > 0) {
+                    usleep($sleepMicroseconds);
+                }
+            }
+        }
+
+        $this->cache->put(
+            $cacheKey,
+            microtime(true),
+            now()->addSeconds((int) max(1, ceil($perSeconds * 2)))
+        );
+    }
+
+    protected function makeCacheKey(string $bucket, string $identity): string
+    {
+        return sprintf(
+            'laravel_bitunix_api:rate_limit:%s:%s',
+            $bucket,
+            sha1($identity)
+        );
+    }
+}

tests/GetTradingPairsTest.php

@@ -0,0 +1,108 @@
+<?php
+
+use Msr\LaravelBitunixApi\Requests\GetTradingPairsRequestContract;
+
+beforeEach(function () {
+    config([
+        'bitunix-api.future_base_uri' => 'https://fapi.bitunix.com/',
+        'bitunix-api.api_key' => 'test-api-key',
+        'bitunix-api.api_secret' => 'test-secret-key',
+        'bitunix-api.language' => 'en-US',
+    ]);
+});
+
+it('check trading pairs request response code', function () {
+    $bootedClass = app(GetTradingPairsRequestContract::class);
+    $response = $bootedClass->getTradingPairs();
+    expect($response->getStatusCode())
+        ->toBe(200)
+        ->and(json_decode($response->getBody()->getContents(), true))
+        ->toHaveKeys(['code', 'data', 'msg']);
+});
+
+it('can get trading pairs with specific symbols', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    expect(fn () => $api->getTradingPairs('BTCUSDT,ETHUSDT'))
+        ->not->toThrow(Exception::class);
+});
+
+it('can get trading pairs without symbols parameter', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    expect(fn () => $api->getTradingPairs())
+        ->not->toThrow(Exception::class);
+});
+
+it('validates get trading pairs method exists', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    expect(method_exists($api, 'getTradingPairs'))->toBeTrue();
+});
+
+it('can handle single symbol', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    expect(fn () => $api->getTradingPairs('BTCUSDT'))
+        ->not->toThrow(Exception::class);
+});
+
+it('can handle multiple symbols', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    $symbols = 'BTCUSDT,ETHUSDT,XRPUSDT';
+    expect(fn () => $api->getTradingPairs($symbols))
+        ->not->toThrow(Exception::class);
+});
+
+it('validates trading pairs response structure', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    $response = $api->getTradingPairs();
+    $data = json_decode($response->getBody()->getContents(), true);
+
+    expect($response->getStatusCode())->toBe(200)
+        ->and($data)->toHaveKeys(['code', 'data', 'msg']);
+
+    if (isset($data['data']) && is_array($data['data']) && count($data['data']) > 0) {
+        $firstPair = $data['data'][0];
+        expect($firstPair)->toHaveKeys([
+            'symbol',
+            'base',
+            'quote',
+            'minTradeVolume',
+            'minBuyPriceOffset',
+            'maxSellPriceOffset',
+            'maxLimitOrderVolume',
+            'maxMarketOrderVolume',
+            'basePrecision',
+            'quotePrecision',
+            'maxLeverage',
+            'minLeverage',
+            'defaultLeverage',
+            'defaultMarginMode',
+            'priceProtectScope',
+            'symbolStatus',
+        ]);
+    }
+});
+
+it('can handle different symbol formats', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    // Test with uppercase symbols
+    expect(fn () => $api->getTradingPairs('BTCUSDT'))
+        ->not->toThrow(Exception::class);
+
+    // Test with lowercase symbols
+    expect(fn () => $api->getTradingPairs('btcusdt'))
+        ->not->toThrow(Exception::class);
+});
+
+it('can handle empty symbols parameter', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    // Test with null (should return all trading pairs)
+    expect(fn () => $api->getTradingPairs(null))
+        ->not->toThrow(Exception::class);
+});