buda 0.0.0 → 0.1.4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 796ca70fb64170e768e952558c775263ba8ae90b8be229f1ccffe2369a406363
-  data.tar.gz: cfd9936ab950257b456a499272bf483b59032e4e25613041326afd51c078fe25
+  metadata.gz: fdc15eb6001b9c923419a9985835dcd3e7962e4e667135066d90714e3b8038a8
+  data.tar.gz: 9910e867b55e96625c2dedeb573297b00cfeac86ebc4792170fcfa085a3b48ef
 SHA512:
-  metadata.gz: 49040c0c76983eddd0efee5baa4207216129d274b8d7590ec6e60a55ea5db15c1ac4213f2558bb252bb2b37fc252503d950f12ac34d0914061ba8681f97f037f
-  data.tar.gz: c3f78daac6a143d651cf7de4755759ca9f641f3e2aad63239c65105aaa2bcf69e831f868321f4420c413507fd2ed0cc81ed5e35ddee420edd3555022b97c8272
+  metadata.gz: e842e8ef9b05b581f4f733565f49bb186e580d0fcd79f3be2bb51b2aeacd1989233717639a1754a36c21180d9be14b204c44e4bc6bb948f17e74f174eb9cff2e
+  data.tar.gz: 77f8652261520842f9a4d22e1fa2633d565d011e755352511cebaf3f73f74799f4ddfe94ee3af210c49301027ccdc4dd455978ba8d3d1b3c685bf4b95fa86d50

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+coverage/*
+Gemfile.lock
+*~
+.bundle
+.rvmrc
+log/*
+measurement/*
+pkg/*
+.DS_Store
+.env
+spec/dummy/tmp/*
+spec/dummy/log/*.log
+demo.rb

data/.rubocop.yml

@@ -0,0 +1,6 @@
+require:
+ - rubocop-performance
+ - rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.7.3
+  NewCops: enable

data/.vscode/settings.json

@@ -0,0 +1 @@
+{}

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fintoc.gemspec
+gemspec
+
+group :test do
+  gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
+end

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rubocop/rake_task'
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommended for running the tests'
+end
+task default: :spec
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'buda'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/buda.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = 'buda'
+  s.version     = '0.1.4.0.4'
+  s.summary     = 'buda.com client'
+  s.description = 'A simple client for buda.com api'
+  s.authors     = ['Alfredo Enrione']
+  s.email       = 'aenrione@protonmail.com'
+  s.homepage    =
+    'https://rubygems.org/gems/buda'
+  s.license = 'MIT'
+  s.required_ruby_version = Gem::Requirement.new('>= 2.7.3')
+  s.add_dependency 'http'
+  s.add_dependency 'json'
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/buda/client.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'buda/utils'
+require 'buda/errors'
+require 'buda/constants'
+require 'buda/version'
+require 'buda/resources/balance'
+require 'buda/resources/deposit'
+require 'buda/resources/withdrawal'
+require 'buda/resources/market'
+require 'json'
+require 'net/http'
+require 'net/https'
+
+module Buda
+  # Client component to make the requests and get data
+  class Client
+    def initialize(api_key, api_secret)
+      @api_key = api_key
+      @api_secret = api_secret
+      @user_agent = "buda-ruby/#{Buda::VERSION}"
+      @headers = {
+        'Content-Type': 'application/json', 'X-SBTC-APIKEY': @api_key,
+        'User-Agent': @user_agent
+      }
+      @default_params = {}
+    end
+
+    def get
+      request('get')
+    end
+
+    def delete
+      request('delete')
+    end
+
+    def request(method)
+      proc do |resource, is_private, **kwargs|
+        parameters = params(method, **kwargs)
+        response = make_request(method, resource, parameters, is_private)
+        content = JSON.parse(response.body, symbolize_names: true)
+
+        # raise_custom_error(content[:error]) if response.status.client_error? || response.status.server_error?
+
+        content
+      end
+    end
+
+    def balances
+      result = get.call('balances', true)[:balances]
+      balances = []
+      result&.each do |balance|
+        balances << Balance.new(**balance)
+      end
+      balances
+    end
+
+    def get_balance(balance_id)
+      result = get.call("balances/#{balance_id}", true)[:balance]
+      Balance.new(**result)
+    end
+
+    def get_market(market_id)
+      market = get.call("markets/#{market_id.upcase}")[:market]
+      ticker = get.call("markets/#{market_id.upcase}/ticker")[:ticker]
+      new_market = Market.new(**market)
+      new_market.set_ticker(**ticker)
+      new_market
+    end
+
+    def deposits(currency)
+      result = get.call("currencies/#{currency}/deposits", true)[:deposits]
+      deposits = []
+      result&.each do |deposit|
+        deposits << Deposit.new(**deposit)
+      end
+      deposits
+    end
+
+    def withdrawals(currency)
+      result = get.call("currencies/#{currency}/withdrawals", true)[:withdrawals]
+      withdrawals = []
+      result&.each do |withdrawal|
+        withdrawals << Withdrawal.new(**withdrawal)
+      end
+      withdrawals
+    end
+
+    def to_s
+      visible_chars = 4
+      hidden_part = '*' * (@api_key.size - visible_chars)
+      visible_key = @api_key.slice(0, visible_chars)
+      "Client(🔑=#{hidden_part + visible_key}"
+    end
+
+    private
+
+    def client
+      @client ||= Net::HTTP
+    end
+
+    def make_request(method, resource, _parameters, is_private)
+      uri = URI.parse("#{Buda::Constants::SCHEME}#{Buda::Constants::BASE_URL}#{resource}")
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+      if is_private
+        req = Net::HTTP::Get.new(uri.path, @headers)
+        req['X-SBTC-SIGNATURE'] = sign(method.upcase, uri.path, '')
+        req['X-SBTC-NONCE'] = nonce
+      else
+        req = Net::HTTP::Get.new(uri.path)
+      end
+      https.request(req)
+    end
+
+    def params(method, **kwargs)
+      if method == 'get'
+        { params: { **@default_params, **kwargs } }
+      else
+        { json: { **@default_params, **kwargs } }
+      end
+    end
+
+    def raise_custom_error(error)
+      raise error_class(error[:code]).new(error[:message], error[:doc_url])
+    end
+
+    def nonce
+      (Time.now.to_i * (10**6)).to_s
+    end
+
+    def sign(method, path, _body)
+      prep = "#{method} #{path} #{nonce}"
+      OpenSSL::HMAC.hexdigest('SHA384', @api_secret, prep)
+    end
+  end
+end

data/lib/buda/constants.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Constant values for the client
+module Buda
+  module Constants
+    FIELDSUBS = [%w[id id_], %w[type type_]].freeze
+    GENERAL_DOC_URL = 'https://api.buda.com/'
+    SCHEME = 'https://'
+    BASE_URL = 'www.buda.com/api/v2/'
+  end
+end

data/lib/buda/errors.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'buda/constants'
+
+module Buda
+  module Errors
+    # Error definitions for handling wrong requests
+    class BudaError < StandardError
+      def initialize(message, doc_url = Buda::Constants::GENERAL_DOC_URL)
+        super()
+        @message = message
+        @doc_url = doc_url
+      end
+
+      def message
+        "\n#{@message}\n Please check the docs at: #{@doc_url}"
+      end
+
+      def to_s
+        message
+      end
+    end
+
+    class InvalidRequestError < BudaError; end
+    class LinkError < BudaError; end
+    class AuthenticationError < BudaError; end
+    class InstitutionError < BudaError; end
+    class ApiError < BudaError; end
+    class MissingResourceError < BudaError; end
+    class InvalidLinkTokenError < BudaError; end
+    class InvalidUsernameError < BudaError; end
+    class InvalidHolderTypeError < BudaError; end
+    class MissingParameterError < BudaError; end
+    class EmptyStringError < BudaError; end
+    class UnrecognizedRequestError < BudaError; end
+    class InvalidDateError < BudaError; end
+    class InvalidCredentialsError < BudaError; end
+    class LockedCredentialsError < BudaError; end
+    class InvalidApiKeyError < BudaError; end
+    class UnavailableInstitutionError < BudaError; end
+    class InternalServerError < BudaError; end
+  end
+end

data/lib/buda/resources/balance.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Buda
+  # for handling the total balance
+  class Balance
+    attr_reader :id, :available, :current, :frozen, :pending
+
+    def initialize(id:, available_amount:, amount:, frozen_amount:, pending_withdraw_amount:, **)
+      @id = id
+      @available = available_amount[0]
+      @current = amount[0]
+      @frozen = frozen_amount[0]
+      @pending = pending_withdraw_amount[0]
+    end
+
+    def to_s
+      "#{id}: #{@current} (#{@available})"
+    end
+
+    def inspect
+      "<Balance #{@current} (#{@available})>"
+    end
+  end
+end

data/lib/buda/resources/currency.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Buda
+  # Client component to make the requests and get data
+  class Client
+    attr_reader :id, :amount
+
+    def initialize(id, amount)
+      @id = id
+      @amount = amount
+    end
+
+    def to_s
+      "#{@amount} (#{@id})"
+    end
+
+    def inspect
+      "<Currency #{@amount} (#{@id})>"
+    end
+  end
+end

data/lib/buda/resources/deposit.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'deposit_data'
+
+module Buda
+  # for handling deposited amount
+  class Deposit
+    attr_reader :id, :created_at, :amount, :currency,
+                :fee, :state, :deposit_data, :account_id,
+                :user_id, :order_id, :order_type, :state_reason,
+                :expected_arrival_time, :reserve_name, :reserve_code
+
+    def initialize(
+      id:, created_at:, amount:, currency:,
+      fee:, state:, account_id:, user_id:,
+      order_id:, order_type:, state_reason:,
+      expected_arrival_time:, reserve_name:, reserve_code:,
+      deposit_data:, **
+    )
+      @id = id
+      @created_at = created_at
+      @amount = amount[0]
+      @currency = currency
+      @fee = fee
+      @state = state
+      @account_id = account_id
+      @user_id = user_id
+      @order_id = order_id
+      @order_type = order_type
+      @state_reason = state_reason
+      @expected_arrival_time = expected_arrival_time
+      @reserve_name = reserve_name
+      @reserve_code = reserve_code
+      @deposit_data = DepositData.new(**deposit_data)
+    end
+
+    def to_s
+      "#{@amount} (#{@currency})"
+    end
+
+    def inspect
+      "<Deposit #{@amount} (#{@currency})>"
+    end
+  end
+end

data/lib/buda/resources/deposit_data.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Buda
+  # for handling deposit_data of Deposit Class
+  class DepositData
+    attr_reader :type, :upload_url, :created_at, :update_at,
+                :tx_hash, :address, :method
+
+    def initialize(
+      type:, upload_url:, created_at:,
+      updated_at:, **kwargs
+    )
+      @type = type
+      @upload_url = upload_url
+      @created_at = created_at
+      @updated_at = updated_at
+      @method = kwargs[:method]
+      @address = kwargs[:address]
+      @tx_hash = kwargs[:tx_hash]
+    end
+
+    def to_s
+      "#{@type} (#{@created_at.to_date})"
+    end
+
+    def inspect
+      "<DepositData #{@type} (#{@created_at.to_date})>"
+    end
+  end
+end

data/lib/buda/resources/fiat_account.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Buda
+  # for handling the total balance
+  class FiatAccount
+    attr_reader :id, :account_number, :created_at, :account_type,
+                :currency
+
+    def initialize(**kwargs)
+      @id = kwargs[:id]
+      @account_number = kwargs[:account_number]
+      @created_at = kwargs[:created_at]
+      @account_type = kwargs[:account_type]
+      @bank_id = kwargs[:bank_id]
+      @currency = kwargs[:currency]
+      @document_number = kwargs[:document_number]
+      @email = kwargs[:email]
+      @phone = kwargs[:phone]
+      @national_number_identifier = kwargs[:national_number_identifier]
+      @bank_name = kwargs[:bank_name]
+      @updated_at = kwargs[:updated_at]
+      @inter_bank_number = kwargs[:inter_bank_number]
+      @source_account = kwargs[:source_account]
+    end
+
+    def to_s
+      "#{@bank_name} (#{@account_number})"
+    end
+
+    def inspect
+      "<FiatAccount #{@bank_name} (#{@account_number})>"
+    end
+  end
+end

data/lib/buda/resources/market.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'ticker'
+
+module Buda
+  # for handling the total balance
+  class Market
+    attr_reader :id, :name, :base_currency, :quote_currency, :minimum_order_amount, :ticker
+
+    def initialize(id:, name:, base_currency:, quote_currency:, minimum_order_amount:, **)
+      @id = id
+      @name = name
+      @base_currency = base_currency
+      @quote_currency = quote_currency
+      @minimum_order_amount = minimum_order_amount
+    end
+
+    def set_ticker(**ticker)
+      @ticker = Buda::Ticker.new(**ticker)
+    end
+
+    def to_s
+      "#{@name} (#{@id})"
+    end
+
+    def inspect
+      "<Market #{@name} (#{@id})>"
+    end
+  end
+end

data/lib/buda/resources/ticker.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Buda
+  # for handling the total balance
+  class Ticker
+    attr_reader :market_id, :last_price, :min_ask, :volume,
+                :max_bid, :price_variation_7d, :price_variation_24h
+
+    def initialize(market_id:,
+                   last_price:, min_ask:,
+                   max_bid:, volume:,
+                   price_variation_24h:, price_variation_7d:, **)
+      @market_id = market_id
+      @last_price = last_price[0]
+      @min_ask = min_ask
+      @max_bid = max_bid
+      @price_variation_24h = price_variation_24h
+      @volume = volume
+      @price_variation_7d = price_variation_7d
+    end
+
+    def to_s
+      "#{@market_id} (#{@last_price})"
+    end
+
+    def inspect
+      "<Ticker #{@market_id} (#{@last_price})>"
+    end
+  end
+end

data/lib/buda/resources/withdrawal.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'withdrawal_data'
+
+module Buda
+  # for handling the total balance
+  class Withdrawal
+    attr_reader :id, :created_at, :amount, :currency,
+                :fee, :state, :deposit_data, :account_id,
+                :user_id, :order_id, :order_type, :state_reason,
+                :expected_arrival_time, :reserve_name, :reserve_code
+
+    def initialize(**kwargs)
+      @id = kwargs[:id]
+      @uuid = kwargs[:uuid]
+      @currency = kwargs[:currency]
+      @created_at = kwargs[:created_at]
+      @forced_reason = kwargs[:forced_reason]
+      @account_id = kwargs[:account_id]
+      @user_id = kwargs[:user_id]
+      @expected_execution_time = kwargs[:expected_execution_time]
+      @expected_arrival_time = kwargs[:expected_arrival_time]
+      @hold_execution = kwargs[:hold_execution]
+      @amount = kwargs[:amount][0]
+      @fee = kwargs[:fee]
+      @usd_amount = kwargs[:usd_amount]
+      @deposit_data = WithdrawalData.new(**kwargs[:withdrawal_data])
+    end
+
+    def to_s
+      "#{@amount} (#{@currency})"
+    end
+
+    def inspect
+      "<Withdrawal #{@amount} (#{@currency})>"
+    end
+  end
+end

data/lib/buda/resources/withdrawal_data.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'buda/resources/fiat_account'
+
+module Buda
+  # for handling the total balance
+  class WithdrawalData
+    attr_reader :type, :id, :created_at, :update_at,
+                :tx_hash, :target_address, :statement_ref,
+                :fiat_account
+
+    def initialize(**kwargs)
+      @type = kwargs[:type]
+      @id = kwargs[:id]
+      @statement_ref = kwargs[:statement_ref]
+      @created_at = kwargs[:created_at]
+      @updated_at = kwargs[:updated_at]
+      @target_address = kwargs[:target_address]
+      @tx_hash = kwargs[:tx_hash]
+      @fiat_account = FiatAccount.new(**kwargs[:fiat_account]) if kwargs[:fiat_account]
+    end
+
+    def to_s
+      "#{@type} (#{@created_at})"
+    end
+
+    def inspect
+      "<WithdrawalData #{@type} (#{@created_at})>"
+    end
+  end
+end

data/lib/buda/utils.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Buda
+  # A handful of run-of-the-mill utilities
+  module Utils
+    module_function
+
+    # Get a flat Array out of a list of lists of Iterables(Enumerators)
+    #
+    def flatten(sequences)
+      Enumerator::Chain.new(*sequences).to_a
+    end
+
+    # If the key exists, you will get that key-value pair.
+    #
+    # @param dict_ [Hash] the hash to pick from
+    # @param key [String] the key to look at
+    # @return [Hash] the key-value pair or an empty hash
+    def pick(dict_, key)
+      key = key.to_sym
+      if dict_.key?(key)
+        { "#{key}": dict_[key] }
+      else
+        {}
+      end
+    end
+
+    # Get a pluralized noun with its appropiate quantifier
+    #
+    # @param amount [Integer]
+    # @param noun [String] the noun to pluralize
+    # @param suffix [String]
+    # @return [String]
+    def pluralize(amount, noun, suffix = 's')
+      quantifier = amount or 'no'
+      "#{quantifier} #{amount == 1 ? noun : noun + suffix}"
+    end
+
+    # Transform a snake-cased name to its pascal-cased version.
+    #
+    # @param name [String]
+    # @return [String]
+    def snake_to_pascal(name)
+      name.split('_').map(&:capitalize).join
+    end
+  end
+end

data/lib/buda/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Buda
+  VERSION = '0.1.0'
+end

data/lib/buda.rb

@@ -1,5 +1,8 @@
-class Buda
-  def self.hi
-    puts "Hello world!"
-  end
+# frozen_string_literal: true
+
+require 'buda/version'
+require 'buda/client'
+
+# Main Module
+module Buda
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buda
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.4.0.4
 platform: ruby
 authors:
 - Alfredo Enrione
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -38,17 +38,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple api client for buda.com
+description: A simple client for buda.com api
 email: aenrione@protonmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".vscode/settings.json"
+- Gemfile
+- Rakefile
+- bin/console
+- bin/setup
+- buda.gemspec
 - lib/buda.rb
+- lib/buda/client.rb
+- lib/buda/constants.rb
+- lib/buda/errors.rb
+- lib/buda/resources/balance.rb
+- lib/buda/resources/currency.rb
+- lib/buda/resources/deposit.rb
+- lib/buda/resources/deposit_data.rb
+- lib/buda/resources/fiat_account.rb
+- lib/buda/resources/market.rb
+- lib/buda/resources/ticker.rb
+- lib/buda/resources/withdrawal.rb
+- lib/buda/resources/withdrawal_data.rb
+- lib/buda/utils.rb
+- lib/buda/version.rb
 homepage: https://rubygems.org/gems/buda
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -57,7 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -67,5 +90,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Hola!
+summary: buda.com client
 test_files: []