quidax 0.1.0

data/lib/quidax/utils.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "error"
+
+# Base Util
+module Utils
+  def self.handle_server_error(event)
+    raise event if event.response.nil?
+
+    error = QuidaxServerError.new(event.response)
+    error_reponse_code = error.response.status
+
+    case error_reponse_code
+    when 400
+      raise error,
+            "HTTP Code 400: Bad request. Review the data sent in the request. Usually, this means a required piece of information is missing"
+    when 401
+      raise error,
+            "HTTP Code 401: Unauthorized. This happens when you provide an invalid or non-existent secret API key"
+    when 404
+      raise error, "HTTP Code 404: Resource not found. The data requested does not exist."
+    when 403
+      raise error, "HTTP Code 403: Forbidden. Not enough permission to perform this operation"
+    when 429
+      raise error, "HTTP Code 429: You're making too many requests!"
+    when 500, 501, 502, 503, 504
+      raise error, "HTTP Code #{error_reponse_code}: Server Error. Something went wrong."
+    end
+  end
+
+  def self.check_missing_keys(required_keys:, keys:, field:)
+    keys.map!(&:to_s)
+    missing_keys = required_keys - keys
+    has_missing_keys = missing_keys.empty?
+    error_message = "missing key(s) in :#{field} #{missing_keys.join(", ")}"
+
+    raise ArgumentError, error_message unless has_missing_keys
+  end
+
+  def self.validate_value_in_array(array:, value:, field:)
+    error_message = ":#{field} must be one of: #{array.join(", ")}"
+
+    raise ArgumentError, error_message unless array.include?(value)
+  end
+
+  def self.validate_value_in_range(range:, value:, field:)
+    raise ArgumentError, "#{field} must be between #{range}" unless range.include?(value.to_i)
+  end
+end

data/lib/quidax/validators/instant_order_validator.rb

@@ -0,0 +1,32 @@
+# validate instant orders
+module InstantOrderValidator
+  def self.validate_buy_from_crypto_body(body)
+    required_body_keys = %w[bid ask volume]
+
+    Utils.check_missing_keys(required_keys: required_body_keys, keys: body.keys, field: "body")
+    validate_bid_currency(body["bid"])
+    validate_ask_currency(body["ask"])
+  end
+
+  def self.validate_sell_crypto_to_fiat(body)
+    required_body_keys = %w[bid ask total]
+
+    Utils.check_missing_keys(required_keys: required_body_keys, keys: body.keys, field: "body")
+    validate_bid_currency(body["bid"])
+    validate_ask_currency(body["ask"])
+  end
+
+  class << self
+    private
+
+    def validate_bid_currency(bid_currency)
+      allowed_bid_currencies = %w[ngn usdt]
+      Utils.validate_value_in_array(array: allowed_bid_currencies, value: bid_currency, field: "bid")
+    end
+
+    def validate_ask_currency(ask_currency)
+      allowed_ask_currencies = %w[btc ltc eth xrp usdt dash usdc busd bnb]
+      Utils.validate_value_in_array(array: allowed_ask_currencies, value: ask_currency, field: "ask")
+    end
+  end
+end

data/lib/quidax/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Quidax
+  VERSION = "0.1.0"
+end

data/lib/quidax.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "faraday"
+require_relative "quidax/version"
+require_relative "quidax/error"
+require_relative "quidax/utils"
+require_relative "quidax/modules/api"
+require_relative "quidax/objects/base"
+require_relative "quidax/objects/user"
+require_relative "quidax/objects/wallet"
+require_relative "quidax/objects/withdrawal"
+require_relative "quidax/objects/markets"
+require_relative "quidax/objects/quote"
+require_relative "quidax/objects/fee"
+require_relative "quidax/objects/trade"
+require_relative "quidax/objects/deposits"
+require_relative "quidax/objects/beneficiary"
+require_relative "quidax/objects/order"
+require_relative "quidax/objects/instant_order"
+
+# Intialize a quidax config object
+class Quidax
+  attr_reader :secret_key
+
+  def initialize(secret_key)
+    raise ArgumentError, "Please pass your secret key" if secret_key.nil?
+
+    @secret_key = secret_key
+  end
+end
+
+# custom Hash Methods
+class Hash
+  def stringify_keys
+    transform_keys(&:to_s)
+  end
+
+  def stringify_keys!
+    transform_keys!(&:to_s)
+  end
+end

data/sig/quidax.rbs

@@ -0,0 +1,4 @@
+module Quidax
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: quidax
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aremu Oluwagbamila
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+description: Ruby gem for Quidax
+email:
+- aremuoluwagbamila@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".vscode/launch.json"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/quidax.rb
+- lib/quidax/error.rb
+- lib/quidax/mocks/deposit_mock.rb
+- lib/quidax/mocks/fees_mock.rb
+- lib/quidax/mocks/markets_mock.rb
+- lib/quidax/mocks/order_mock.rb
+- lib/quidax/mocks/quotes_mock.rb
+- lib/quidax/mocks/user_mock.rb
+- lib/quidax/mocks/wallet_mock.rb
+- lib/quidax/mocks/withdrawal_mock.rb
+- lib/quidax/modules/api.rb
+- lib/quidax/objects/base.rb
+- lib/quidax/objects/beneficiary.rb
+- lib/quidax/objects/deposits.rb
+- lib/quidax/objects/fee.rb
+- lib/quidax/objects/instant_order.rb
+- lib/quidax/objects/markets.rb
+- lib/quidax/objects/order.rb
+- lib/quidax/objects/quote.rb
+- lib/quidax/objects/trade.rb
+- lib/quidax/objects/user.rb
+- lib/quidax/objects/wallet.rb
+- lib/quidax/objects/withdrawal.rb
+- lib/quidax/utils.rb
+- lib/quidax/validators/instant_order_validator.rb
+- lib/quidax/version.rb
+- sig/quidax.rbs
+homepage: https://github.com/aremu-smog/quidax-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aremu-smog/quidax-ruby
+  source_code_uri: https://github.com/aremu-smog/quidax-ruby
+  changelog_uri: https://github.com/aremu-smog/quidax-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Quidax gem for Ruby/Rails
+test_files: []