bittrex-pro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e046a1a29f0fd811cd343623b70b6ce253ae6a8
+  data.tar.gz: 0646266bc74adbc384e15231164684c35527435f
+SHA512:
+  metadata.gz: fd05ac629f845e609d5f9987e4f72c2a72ebc6e4c0b75d592684df248e2ced4637794e4a48b4aca58e75aa825c5449d1da9ab1f16000932ba8de5a35f325b444
+  data.tar.gz: 26d9c4fc38bfeda1b2f74a5e5c0319c7fca6c12b1b37f46db7ead9a0f3640ecdee5a8b50e64355d1ae9e69825545eae3c1d3e64327fce41d70568635e2bd4608

data/.circleci/config.yml

@@ -0,0 +1,58 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.3.3-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                --format RspecJunitFormatter \
+                --out /tmp/test-results/rspec.xml \
+                --format progress \
+                -- \
+                $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,28 @@
+.DS_Store
+*.gem
+*.rbc
+.rspec
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+script
+
+# Ignore application configuration
+/config/application.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2018 American Trade Exchange, Inc.
+
+MIT License
+
+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,53 @@
+# Bittrex Pro
+
+Unofficial gem for the Bittrex API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bittrex-pro'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bittrex-pro
+
+## Usage
+
+The gem uses a simple mapping of API resources to models, with a majority of the attributes mapped to corresponding attributes on the corresponding class. There are some translations into a more "rubyish" verbage, but for the most part things are directly mapped.
+
+    require 'rubygems'
+    require 'bittrex-pro'
+    >> Quote.current('BTC-LTC')
+    #=> #<Bittrex::Quote:0x000001015cd058 @market="BTC-LTC", @bid=0.015792, @ask=0.01602899, @last=0.015792, @raw={"Bid"=>0.015792, "Ask"=>0.01602899, "Last"=>0.015792}>
+
+## Authentication
+
+You can authenticate access to your Bittrex account by configuring your implementation of the bittrex-pro gem. This is accomplished by using a config block at the top of your application.
+
+Set up your keys at: https://bittrex.com/manage
+
+    Bittrex.config do |c|
+      c.key = 'my_api_key'
+      c.secret = 'my_api_secret'
+    end
+
+## Development
+
+You can test out public API calls any time by running `bundle exec rake bittrex:console` and inputting your method.
+
+If you want to test private API calls, you will need to create `config/application.yml` and add your Bittrex keys to it (`config/application.yml.example` provides a template for this).
+
+Once you've added the API keys, run `bundle exec rake bittrex:console`
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bittrex-pro/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'figaro'
+
+Figaro.application.path = File.expand_path('../config/application.yml', __FILE__)
+Figaro.load
+
+namespace :bittrex do
+  task :console do
+    exec "irb -r bittrex -I ./lib"
+  end
+end

data/bittrex-pro.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bittrex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bittrex-pro"
+  spec.version       = Bittrex::VERSION
+  spec.authors       = ["Vertbase"]
+  spec.email         = ["dev@vertbase.com"]
+  spec.summary       = %q{API Client for the Bittrex API}
+  spec.description   = %q{API Client for the Bittrex API}
+  spec.homepage      = "https://github.com/vertbase/bittrex-pro"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '>= 0.9.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "figaro"
+end

data/config/application.yml.example

@@ -0,0 +1,2 @@
+bittrex_api_key: xxx
+bittrex_api_secret: yyy

data/lib/bittrex.rb

@@ -0,0 +1,32 @@
+require "bittrex/version"
+
+module Bittrex
+  autoload :Helpers,       'bittrex/helpers'
+  autoload :Market,        'bittrex/market'
+  autoload :Client,        'bittrex/client'
+  autoload :Configuration, 'bittrex/configuration'
+  autoload :Currency,      'bittrex/currency'
+  autoload :Deposit,       'bittrex/deposit'
+  autoload :Order,         'bittrex/order'
+  autoload :Quote,         'bittrex/quote'
+  autoload :Summary,       'bittrex/summary'
+  autoload :Wallet,        'bittrex/wallet'
+  autoload :Withdrawal,    'bittrex/withdrawal'
+
+  def self.client
+    @client ||= Client.new(configuration.auth)
+  end
+
+  def self.config
+    yield configuration
+    @client = Client.new(configuration.auth)
+  end
+
+  def self.configuration
+    Configuration.instance
+  end
+
+  def self.root
+    File.expand_path('../..', __FILE__)
+  end
+end

data/lib/bittrex/client.rb

@@ -0,0 +1,46 @@
+require 'faraday'
+require 'base64'
+require 'json'
+
+module Bittrex
+  class Client
+    HOST = 'https://bittrex.com/api/v1.1'
+
+    attr_reader :key, :secret
+
+    def initialize(attrs = {})
+      @key    = attrs[:key]
+      @secret = attrs[:secret]
+    end
+
+    def get(path, params = {}, headers = {})
+      nonce = Time.now.to_i
+      response = connection.get do |req|
+        url = "#{HOST}/#{path}"
+        req.params.merge!(params)
+        req.url(url)
+
+        if key
+          req.params[:apikey]   = key
+          req.params[:nonce]    = nonce
+          req.headers[:apisign] = signature( connection.build_exclusive_url(req.path, req.params), nonce)
+        end
+      end
+
+      JSON.parse(response.body)['result']
+    end
+
+    private
+
+    def signature(url, nonce)
+      OpenSSL::HMAC.hexdigest('sha512', secret, "#{url}")
+    end
+
+    def connection
+      @connection ||= Faraday.new(:url => HOST) do |faraday|
+        faraday.request  :url_encoded
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/bittrex/configuration.rb

@@ -0,0 +1,33 @@
+require 'singleton'
+
+module Bittrex
+  class Configuration
+    include Singleton
+
+    attr_accessor :key, :secret
+
+    @@defaults = {
+      key: ENV['bittrex_api_key'],
+      secret: ENV['bittrex_api_secret']
+    }
+
+    def self.defaults
+      @@defaults
+    end
+
+    def initialize
+      reset
+    end
+
+    def auth
+      {
+        key: key,
+        secret: secret
+      }
+    end
+
+    def reset
+      @@defaults.each_pair { |k, v| send("#{k}=", v) }
+    end
+  end
+end

data/lib/bittrex/currency.rb

@@ -0,0 +1,27 @@
+module Bittrex
+  class Currency
+    attr_reader :name, :abbreviation, :minimum_confirmation, :transaction_fee, :active, :raw
+
+    alias_method :min_confirmation, :minimum_confirmation
+    alias_method :fee, :transaction_fee
+
+    def initialize(attrs = {})
+      @name = attrs['CurrencyLong']
+      @abbreviation = attrs['Currency']
+      @transaction_fee = attrs['TxFee']
+      @minimum_confirmation = attrs['MinConfirmation']
+      @active = attrs['IsActive']
+      @raw = attrs
+    end
+
+    def self.all
+      client.get('public/getcurrencies').map{|data| new(data) }
+    end
+
+    private
+
+    def self.client
+      @client ||= Bittrex.client
+    end
+  end
+end

data/lib/bittrex/deposit.rb

@@ -0,0 +1,29 @@
+module Bittrex
+  class Deposit
+    include Helpers
+
+    attr_reader :id, :transaction_id, :address, :quantity, :currency, :confirmations, :executed_at
+    attr_reader :raw
+
+    def initialize(attrs = {})
+      @id = attrs['Id']
+      @transaction_id = attrs['TxId']
+      @address = attrs['CryptoAddress']
+      @quantity = attrs['Amount']
+      @currency = attrs['Currency']
+      @confirmations = attrs['Confirmations']
+      @executed_at = extract_timestamp(attrs['LastUpdated'])
+      @raw = attrs
+    end
+
+    def self.all
+      client.get('account/getdeposithistory').map{|data| new(data) }
+    end
+
+    private
+
+    def self.client
+      @client ||= Bittrex.client
+    end
+  end
+end

data/lib/bittrex/helpers.rb

@@ -0,0 +1,10 @@
+require 'date'
+
+module Bittrex
+  module Helpers
+    def extract_timestamp(value)
+      return if value.nil? or value.strip.empty?
+      DateTime.parse value
+    end
+  end
+end

data/lib/bittrex/market.rb

@@ -0,0 +1,31 @@
+require 'time'
+
+module Bittrex
+  class Market
+    include Helpers
+
+    attr_reader :name, :currency, :base, :currency_name, :base_name, :minimum_trade, :active, :created_at, :raw
+
+    def initialize(attrs = {})
+      @name = attrs['MarketName']
+      @currency = attrs['MarketCurrency']
+      @base = attrs['BaseCurrency']
+      @currency_name = attrs['MarketCurrencyLong']
+      @base_name = attrs['BaseCurrencyLong']
+      @minimum_trade = attrs['MinTradeSize']
+      @active = attrs['IsActive']
+      @created_at = extract_timestamp(attrs['Created'])
+      @raw = attrs
+    end
+
+    def self.all
+      client.get('public/getmarkets').map{|data| new(data) }
+    end
+
+    private
+
+    def self.client
+      @client ||= Bittrex.client
+    end
+  end
+end