quidax 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d57e41e7f2ccf18203238cc7c9611a1abdaff3edc6168748c8011882daf36fc
+  data.tar.gz: 986fbc758fda6512fe75333c16102a96ee8b1711f96d5b889370ff2ff02a4f52
+SHA512:
+  metadata.gz: 88da99c664a4301e192436df5e3d658f3d1efc5262374f0dd8fc8eda597b25f9af3b68bb561316ed0beff7009346d4355a43863c8afc2faaad86cdc19ee3655e
+  data.tar.gz: ba08bc8aa067a7947df19250fbca958e0fd48c8937c7415c8401742c678538698ab4264475485b8daf87fdc8cb1c38f71e8c501dd107ac70d4213b8559efdade

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 500
+
+Metrics/BlockLength:
+  Max: 500
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Naming/MethodName:
+  EnforcedStyle: snake_case
+
+Metrics/ParameterLists:
+  Max: 7

data/.vscode/launch.json

@@ -0,0 +1,22 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "ruby_lsp",
+      "name": "Debug",
+      "request": "launch",
+      "program": "ruby ${file}"
+    },
+    {
+      "type": "ruby_lsp",
+      "request": "launch",
+      "name": "Debug test file",
+      "program": "ruby -Itest ${relativeFile}"
+    },
+    {
+      "type": "ruby_lsp",
+      "request": "attach",
+      "name": "Attach to existing server"
+    }
+  ]
+}

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-07
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in quidax.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    quidax (0.1.0)
+      faraday (~> 2.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    bigdecimal (3.1.6)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    dotenv (2.8.1)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    hashdiff (1.1.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    net-http (0.4.1)
+      uri
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.60.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+    uri (0.13.0)
+    webmock (3.23.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-23
+
+DEPENDENCIES
+  dotenv (~> 2.8.1)
+  quidax!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  webmock (~> 3.19)
+
+BUNDLED WITH
+   2.5.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Aremu Oluwagbamila
+
+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,86 @@
+![Quidax](https://res.cloudinary.com/aremusmog/image/upload/v1710023421/quidax-ruby/quidax_bwwbks.svg)
+
+# Quidax Ruby Library
+
+![RSpec Test status](https://github.com/aremu-smog/quidax-ruby/actions/workflows/rspec.yml/badge.svg)
+
+A ruby gem for easy integration of [Quidax](https://docs.quidax.com/docs/getting-started). Please kindly see the [docs](https://docs.quidax.com/docs/getting-started) to get a sense of how the API behaves
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quidax'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install quidax
+
+## Usage
+
+### Instantiate a Quidax Object
+
+To use the SDK, you need to instantiate a quidax object with a secret key
+
+```
+secret_key = ENV["QUIDAX_SECRET_KEY"]
+
+quidax_object = Quidax.new(secret_key)
+```
+
+### Using an object
+
+See the [table](#quidax-objects) below for a list of available objects.
+Kindly note that all objects and methods accepts parameters via named keywords.
+There are two ways to use an object:
+
+#### 1. Accessing methods after initializing object instance
+
+In this case you need to pass your `quidax_object` once to the object instance, and you will now be able to access methods on the class. The keyword is `q_object`
+
+```
+markets = QuidaxMarkets(q_object: quidax_object)
+
+all_market_tickers = markets.get_all_tickers
+```
+
+#### 2. Accessing methods directly from the object
+
+In this case you need to pass `quidax_object` to the method you directly calling, the `keyword` is `q_object`
+
+```
+all_market_tickers = QuidaxMarket.get_all_tickers(q_object: quidax_object)
+```
+
+> Like you may suspect, the parameters that each method differs, please kindly see the [docs](https://docs.quidax.com/docs/getting-started) to know the expected parameters, `query:` is used to get requests with a payload, while `body:` is used for `post`/`put` requests with a payload
+
+## Quidax Objects
+
+| Object             | Methods                                                                                                                                                                                 |
+| :----------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| QuidaxBeneficiary  | get_all <br/> create <br/> get_account <br/> edit_account                                                                                                                               |
+| QuidaxDeposits     | by_user <br /> get_a_deposit <br/> by_sub_users                                                                                                                                         |
+| QuidaxInstantOrder | get_all <br /> by_sub_users <br/> get_detail <br/> buy_crypto_from_fiat <br/> sell_crypto_to_fiat <br/> confirm <br/> requote                                                           |
+| QuidaxMarkets      | get_all <br/> get_all_tickers <br/> get_ticker <br/> get_k_line <br /> get_k_line_with_pending_trades <br/> get_orderbook_items <br/> get_depth_for_a_market                            |
+| QuidaxOrder        | get_all <br/> create <br /> cancle <br/> get_details                                                                                                                                    |
+| QuidaxQuote        | get                                                                                                                                                                                     |
+| QuidaxTrade        | for_user <br/> for_market                                                                                                                                                               |
+| QuidaxUser         | get_account_details <br/> create_sub_account <br/> get_all_sub_accounts <br/> edit_account <br/>                                                                                        |
+| QuidaxWallet       | get_user_wallets <br/> get_user_wallet <br/> get_payment_address <br/> get_payment_address_by_id <br/> get_payment_addresses <br/> create_crypto_payment_address <br/> validate_address |
+| QuidaxWithdrawal   | get_all_withdrawals_detail <br/> get_detail <br/> cancel                                                                                                                                |
+
+## Development
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aremu-smog/quidax-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/quidax/error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Base for errors thrown by the quidax server
+class QuidaxServerError < StandardError
+  attr_reader :response
+
+  def initialize(response)
+    super(response)
+    @response = response
+  end
+end

data/lib/quidax/mocks/deposit_mock.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DepositMock
+  A_DEPOSIT = {
+    id: "122345",
+    type: "",
+    currency: "",
+    amount: "",
+    fee: "",
+    txid: "",
+    status: "",
+    reason: "",
+    created_at: "",
+    done_at: "",
+    wallet: {},
+    user: {},
+    payment_transaction: {},
+    payment_address: {}
+  }.freeze
+end

data/lib/quidax/mocks/fees_mock.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module FeesMock
+  BTC_FEE = {
+    fee: 0.00005,
+    type: "flat"
+  }.freeze
+end

data/lib/quidax/mocks/markets_mock.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module MarketsMock
+  ALL_MARKETS = [
+    {
+      id: "1",
+      name: "qdxusdt",
+      base_unit: "qdx",
+      quote_unit: "usdt",
+      filters: {}
+    }
+  ].freeze
+
+  QDX_USDT_ORDERBOOK_ITEMS_FOR_MARKET = {
+    asks: [{}],
+    bids: [{}]
+  }.freeze
+
+  QDX_USDT_MARKET_KLINE = [0.0005, 0.0049, 0.00051, 0.0005].freeze
+  QDX_USDT_K_WITH_PENDING_TRADES = {
+    k: QDX_USDT_MARKET_KLINE,
+    trades: [
+      { tid: 1, type: "buy", date: 2002, price: 0.0005, base_volume: 2000, quote_volume: 2001 }
+    ]
+  }.freeze
+
+  QDX_USDT_MARKET_TICKER = {
+    at: 1,
+    ticker: {
+      buy: "0.00055",
+      sell: "0.00054",
+      low: "0.00052",
+      high: "0.00057",
+      open: "0.00034",
+      last: "0.00053",
+      vol: "20000"
+    },
+    market: "qdxusdt"
+  }.freeze
+
+  ALL_MARKET_TICKERS =
+    {
+      "qdxusdt": QDX_USDT_MARKET_TICKER
+    }.freeze
+
+  QDX_USDT_MARKET_DEPTH = {
+    timestamp: 120_290_909,
+    asks: ["0.0005", "0.00049", "0.00051"],
+    bids: ["0.00041", "0.00045", "0.00055"]
+  }.freeze
+end

data/lib/quidax/mocks/order_mock.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OrderMock
+  ORDER_DETAILS = {
+    id: "sample",
+    reference: "1lkj2lw30",
+    market: {},
+    side: "buy",
+    order_type: "limit",
+    price: {},
+    avg_price: {},
+    volume: {},
+    origin_volume: {},
+    executed_volume: {},
+    status: "pend",
+    trades_count: 1,
+    created_at: "",
+    updated_at: "",
+    done_at: "",
+    user: {},
+    trades: []
+  }.freeze
+end

data/lib/quidax/mocks/quotes_mock.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module QuotesMock
+  QDX_USDT_QUOTE = {
+    price: {
+      unit: "usdt",
+      amount: "0.005"
+    },
+    total: {
+      unit: "usdt",
+      amount: "0.010"
+    },
+    volume: {
+      unit: "usdt",
+      amount: "2"
+    },
+    fee: {
+      unit: "usdt",
+      amount: "0.001"
+    },
+    receive: {
+      unit: "usdt",
+      amount: "0.0010"
+    }
+  }.freeze
+end

data/lib/quidax/mocks/user_mock.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module UserMock
+  ACCOUNT = {
+    id: "QSKDJLK",
+    sn: "2",
+    email: "test@domain.com",
+    reference: "",
+    first_name: "Aremu",
+    last_name: "Smog",
+    display_name: "null",
+    created_at: "",
+    updated_at: ""
+  }.freeze
+
+  ALL_SUBACCOUNTS = [
+    {
+      id: "QSKDJLK",
+      sn: "2",
+      email: "test@domain.com",
+      reference: "ajlkskl",
+      first_name: "Aremu",
+      last_name: "Smog",
+      display_name: "null",
+      created_at: "",
+      updated_at: ""
+    },
+    {
+      id: "QS3DJLK",
+      sn: "4",
+      email: "test@domain.com",
+      reference: "sjld",
+      first_name: "Aremu",
+      last_name: "Smog",
+      display_name: "null",
+      created_at: "",
+      updated_at: ""
+    }
+  ].freeze
+
+  NEW_USER = { # rubocop:disable Style/MutableConstant
+    email: "test@domain.com",
+    first_name: "Aremu",
+    last_name: "Smog",
+    phone_number: "09012345678"
+  }
+
+  UPDATE_INFO = {
+    first_name: "Daddy"
+  }.freeze
+
+  UPDATED_ACCOUNT = {
+    id: "QSKDJLK",
+    sn: "2",
+    email: "test@domain.com",
+    reference: "",
+    first_name: "Daddy",
+    last_name: "Smog",
+    display_name: "null",
+    created_at: "",
+    updated_at: ""
+  }.freeze
+end

data/lib/quidax/mocks/wallet_mock.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module WalletMock
+  ALL_WALLETS = [
+    {
+      id: "ppsoudo",
+      currency: "btc",
+      balance: "0.0001",
+      locked: "0",
+      staked: "0",
+      user: {},
+      converted_balance: "55",
+      reference_currency: "usdt",
+      is_crypto: true,
+      created_at: "",
+      updated_at: ""
+    },
+    {
+      id: "ppsoudo",
+      currency: "usdt",
+      balance: "500",
+      locked: "0",
+      staked: "0",
+      user: {},
+      converted_balance: "750000",
+      reference_currency: "ngn",
+      is_crypto: false,
+      created_at: "",
+      updated_at: ""
+    }
+  ].freeze
+
+  ALL_BTC_PAYMENT_ADDRESS = [
+    {
+      id: "34",
+      reference: "sjlkjldk",
+      currency: "btc",
+      address: "9302983093",
+      destination_tag: "Quser",
+      total_payments: "0.1234",
+      created_at: "",
+      updated_at: ""
+    },
+    {
+      id: "35",
+      reference: "ssjlkdljkjldk",
+      currency: "btc",
+      address: "93043303093",
+      destination_tag: "Quser",
+      total_payments: "0.2034",
+      created_at: "",
+      updated_at: ""
+    }
+  ].freeze
+
+  NEW_PAYMENT_ADDRESS = {
+    id: "36",
+    reference: "670",
+    currency: "btc",
+    address: "9302983093",
+    destination_tag: "Quser",
+    total_payments: "0.1534",
+    created_at: "",
+    updated_at: ""
+  }.freeze
+
+  PAYMENT_ADDRESS = {
+    id: "34",
+    reference: "sjlkjldk",
+    currency: "btc",
+    address: "9302983093",
+    destination_tag: "Quser",
+    total_payments: "0.1234",
+    created_at: "",
+    updated_at: ""
+  }.freeze
+
+  WALLET = {
+    id: "ppsoudo",
+    currency: "btc",
+    balance: "0.0001",
+    deposit_address: "sljdlkjsdld",
+    destination_tag: "skjd",
+    locked: "0",
+    staked: "0",
+    user: {},
+    converted_balance: "55",
+    reference_currency: "usdt",
+    is_crypto: true,
+    created_at: "",
+    updated_at: ""
+  }.freeze
+
+  VALID_ADDRESS = {
+    currency: "btc",
+    address: "1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71",
+    valid: false
+  }.freeze
+end

data/lib/quidax/mocks/withdrawal_mock.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module WithdrawalMock
+  ALL_BTC_WITHDRAWAL_DETAILS = [].freeze
+
+  WITHDRAWAL = {
+    id: "1234",
+    reference: "ksjdlkssjld",
+    type: "",
+    currency: "usdt",
+    amount: "2000",
+    fee: "2",
+    total: "2002",
+    txid: "jslkdjlsj",
+    transaction_note: "stay alive",
+    narration: "staying alive funds",
+    status: "pend",
+    reason: "nil",
+    created_at: "",
+    done_at: "",
+    recipient: {},
+    wallet: {},
+    user: {}
+  }.freeze
+
+  CANCELLED_WITHDRAWAL = {}
+end

data/lib/quidax/modules/api.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Add in alphabetical order
+module API
+  BASE_URL = "https://www.quidax.com/api/v1"
+  BENEFICIARY_PATH = "/beneficiaries"
+  DEPOSIT_PATH = "/deposits"
+  FEE_PATH = "/fee"
+  INSTANT_ORDER_PATH = "/instant_orders"
+  MARKET_PATH = "/markets"
+  ORDER_PATH = "/orders"
+  QUOTE_PATH = "/quotes"
+  TRADES_PATH = "/trades"
+  USER_PATH = "/users"
+  WALLET_PATH = "/wallets"
+  WITHDRAWAL_PATH = "/withdraws"
+end