ru_bittrex 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 18d0a412304dc74b70d6d3aabb78f48a514620bb8fb4b2bc683bd1dea7b18711
+  data.tar.gz: '0588a04c4eec8630ba2ac650c0df1384b5924f1083d44bf09dfeca4a164e5aec'
+SHA512:
+  metadata.gz: dcead54bb062b4322610fc19ccf768480c4092dc156a4d7a53d2682e7fb477fd19d7c9e73d9a32ad2e6cba49548e98107f0c2c5143e9d969ebb7d78c96d0552c
+  data.tar.gz: '0792bbd48dd7fd388fbefe0131eeba5b9050778f215894ca3564cd987112f9de86b9b65aa3b8b030c9059faefd34bfec58660d514ab0f06ceaad41984085041d'

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+credentials.yml

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    ru_bittrex (0.2.0)
+      faraday (~> 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    minitest (5.14.2)
+    mocha (1.11.2)
+    multipart-post (2.1.1)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  mocha (~> 1.11.2)
+  rake (~> 12.0)
+  ru_bittrex!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 david metta
+
+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,134 @@
+# RuBittrex
+
+RuBittrex is a Ruby wrapper for the Bittrex API.
+
+Currently RuBittrex only supports [Bittrex API V3](https://bittrex.github.io/api/v3) and is available for use with multiple clients (multiple Bittrex accounts).
+
+## Table of Contents
+- [Installation](#installation) 
+- [Usage](#usage)
+- [Development](#development)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ru_bittrex'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ru_bittrex
+   
+## Usage
+
+#### Auth Configuration
+In Order to use RuBittrex you must add authentication configuration after requiring the gem, or in an initializer.
+```ruby
+RuBittrex.configure do |config|
+  config.api_key = "MY_API_KEY"
+  config.secret  = "MY_SECRET"
+end
+```
+
+#### Basic Usage
+Once configured you can use any of the classes by calling class methods directly:
+```ruby
+RuBittrex::Currency.get('btc')
+```
+The code above returns an instance of `RuBittrex::Currency`
+
+This is a comprehensive list of the classes available and their methods:
+```ruby
+RuBittrex::Account.get
+RuBittrex::Account.volume
+
+RuBittrex::Address.all
+RuBittrex::Address.get(currency) #==> RuBittrex::Address.get('btc')
+
+RuBittrex::Balance.all
+RuBittrex::Balance.get(currency) #==> RuBittrex::Balance.get('btc')
+
+RuBittrex::Currency.all
+RuBittrex::Currency.get(symbol) #==> RuBittrex::Currency.get('btc')
+
+RuBittrex::Deposit.open(opts) #==> RuBittrex::Deposit.get(status: 'PENDING')
+RuBittrex::Deposit.closed(opts) #==> RuBittrex::Deposit.get(status: 'COMPLETED')
+RuBittrex::Deposit.get(id) #==> RuBittrex::Deposit.get('353fd-etwv-wrtvv')
+
+RuBittrex::Market.all
+RuBittrex::Market.get(symbol) #==> RuBittrex::Market.get('btc-eth')
+
+RuBittrex::Summary.all
+RuBittrex::Summary.get(market) #==> RuBittrex::Summary.get('btc-eth')
+
+RuBittrex::Ticker.all
+RuBittrex::Ticker.get(market) #==> RuBittrex::Ticker.get('btc-eth')
+```
+For the full list of options and params please refer to the [Bittrex API Documentation](https://bittrex.github.io/api/v3)
+
+#### Client Usage
+Alternatively you can instantiate the client directly, and then call the methods from there.
+```ruby
+client = RuBittrex::Client.new(api_key: 'MY_API_KEY', secret: 'MY_SECRET')
+client.currency('btc')
+```
+The code above returns an instance of `RuBittrex::Currency`
+
+This is especially useful when needing to perform actions from multiple clients (hence multiple accounts).
+
+This is a comprehensive list of the methods available from the client:
+```ruby
+client.account
+client.account_volume
+
+client.addresses
+client.address(currency) #===> client.address('btc')
+
+client.balances
+client.balance(currency) #===> client.balance('btc')
+
+client.currencies
+client.currency(symbol) #===> client.currency('btc')
+
+client.open_deposits(opts) #===> client.open_deposit(status: 'PENDING')
+client.closed_deposits(opts) #===> client.closed_deposit(status: 'COMPLETED')
+client.deposit(id) #===> client.deposit('353fd-etwv-wrtvv')
+
+client.markets
+client.market(symbol) #===> client.market('btc-eth')
+
+client.summaries
+client.summary(market) #===> client.summary('btc-eth')
+
+client.tickers
+client.ticker(market) #===> client.ticker('btc-eth')
+```
+For the full list of options and params please refer to the [Bittrex API Documentation](https://bittrex.github.io/api/v3)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+When using the gem in development remember to create a `credentials.yml` file in the root of the library folder and insert a valid **api_key** and **secret** from Bittrex. You can find an example in `credentials.example.yml`.
+
+
+## Testing
+
+To test the gem simply run `rake test` from the root of the library folder.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/davidmetta/ru_bittrex.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "ru_bittrex"
+require 'yaml'
+require "irb"
+
+creds = YAML.load_file('credentials.yml')
+RuBittrex.configure do |config|
+  config.api_key = creds["api_key"]
+  config.secret  = creds["secret"]
+end
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/credentials.example.yml

@@ -0,0 +1,4 @@
+api_key:
+  543hw6h57h647j65j75687j456j4j746
+secret:
+  43hhgergjetyk6k5ij635j654k36k45y

data/lib/ru_bittrex.rb

@@ -0,0 +1,47 @@
+require "ru_bittrex/version"
+
+module RuBittrex
+  class Error < StandardError; end
+  class AuthError < Error; end
+
+  autoload :Configuration, 'ru_bittrex/configuration'
+  autoload :Client,        'ru_bittrex/client'
+  autoload :ClientApi,     'ru_bittrex/client_api'
+  autoload :ClientHelper,  'ru_bittrex/client_helper'
+  autoload :Helpers,       'ru_bittrex/helpers'
+  autoload :Account,       'ru_bittrex/account'
+  autoload :Address,       'ru_bittrex/address'
+  autoload :Balance,       'ru_bittrex/balance'
+  autoload :Currency,      'ru_bittrex/currency'
+  autoload :Deposit,       'ru_bittrex/deposit'
+  autoload :Market,        'ru_bittrex/market'
+  autoload :Order,         'ru_bittrex/order'
+  autoload :Summary,       'ru_bittrex/summary'
+  autoload :Ticker,        'ru_bittrex/ticker'
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset_config
+      @configuration = Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def client
+      @client ||= Client.new(configuration.auth)
+    end
+
+    def reset_client
+      @client = nil
+    end
+
+    def root
+      File.expand_path('../..', __FILE__)
+    end
+  end
+end

data/lib/ru_bittrex/account.rb

@@ -0,0 +1,24 @@
+module RuBittrex
+  class Account
+    extend ClientHelper
+    include Helpers
+
+    attr_reader :id, :updated_at, :volume_30_days, :raw
+    alias_method :volume, :volume_30_days
+
+    def initialize(attrs = {})
+      @id             = attrs["accountId"]
+      @updated_at     = extract_timestamp(attrs["updated"])
+      @volume_30_days = attrs["volume30days"]
+      @raw            = attrs
+    end
+
+    def self.get(params = {})
+      new _get('account', params)
+    end
+
+    def self.volume(params = {})
+      new _get('account/volume', params)
+    end
+  end
+end

data/lib/ru_bittrex/address.rb

@@ -0,0 +1,26 @@
+module RuBittrex
+  class Address
+    extend ClientHelper
+
+    attr_reader :status, :currency, :address, :raw
+
+    def initialize(attrs = {})
+      @status   = attrs["status"]
+      @currency = attrs["currencySymbol"]
+      @address  = attrs["cryptoAddress"]
+      @raw      = attrs
+    end
+
+    def self.all(params = {})
+      collection _get('addresses', params)
+    end
+
+    def self.get(currency, params = {})
+      new _get("addresses/#{currency}", params)
+    end
+
+    # TODO: provision new address
+    # def self.create
+    # end
+  end
+end

data/lib/ru_bittrex/balance.rb

@@ -0,0 +1,25 @@
+module RuBittrex
+  class Balance
+    extend ClientHelper
+    include Helpers
+
+    attr_reader :currency, :total, :available, :updated_at, :raw
+
+    def initialize(attrs = {})
+      @currency   = attrs["currencySymbol"]
+      @total      = attrs["total"]
+      @available  = attrs["available"]
+      @updated_at = extract_timestamp(attrs["updatedAt"])
+      @raw        = attrs
+    end
+
+    def self.all(params = {})
+      collection _get('balances', params)
+    end
+
+    # TODO: check that currency exists
+    def self.get(currency, params = {})
+      new _get("balances/#{currency}", params)
+    end
+  end
+end

data/lib/ru_bittrex/client.rb

@@ -0,0 +1,69 @@
+require 'faraday'
+require 'digest'
+require 'openssl'
+require 'uri'
+require 'json'
+
+module RuBittrex
+  class Client
+    include ClientApi
+
+    API_URI = 'https://api.bittrex.com/v3'
+
+    attr_reader :secret, :api_key
+
+    def initialize(opts = {})
+      raise AuthError.new('You must provide API key and Secret') unless opts[:secret] && opts[:api_key]
+
+      @secret = opts[:secret]
+      @api_key = opts[:api_key]
+    end
+
+    def get(path, params = {})
+      uri = encode_uri(path, params)
+      timestamp = nonce
+      content_hash = digest
+      presign = timestamp.to_s + uri + 'GET' + content_hash
+
+      resp = Faraday.get(uri) do |req|
+        req.params = params
+        # req.params['limit'] = 100
+        req.headers['Api-Key'] = @api_key
+        req.headers['Api-Timestamp'] = timestamp.to_s
+        req.headers['Api-Content-Hash'] = content_hash
+        req.headers['Api-Signature'] = sign(presign)
+        req.headers['Content-Type'] = 'application/json'
+        # req.body = body.to_json
+      end
+
+      JSON.parse(resp.body)
+    end
+
+    private
+
+    def encode_uri(path, params)
+      uri = API_URI + '/' + path
+      uri = uri + '?' + URI.encode_www_form(params) if params.any?
+      uri
+    end
+
+    def nonce
+      (Time.now.to_f * 1000).to_i
+    end
+
+    def digest(body = nil)
+      string =
+        if body.is_a?(Hash)
+          body.to_json
+        elsif body.nil?
+          ''
+        end
+
+      Digest::SHA512.hexdigest(string)
+    end
+
+    def sign(presign)
+      OpenSSL::HMAC.hexdigest('sha512', @secret, presign)
+    end
+  end
+end