bittrex_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37a2d6bd9d534a7d57e9e31608f623c2056df0648555c3aeb7dae1450612e92c
+  data.tar.gz: 6ef6d2974b9205c063ba5185501014f5a89cf0643a27c2c8cc9a157fc8870197
+SHA512:
+  metadata.gz: d67a01526eb0d81edfc006e50a51fcb923e66523dcf9bd6482ec80ced644cdf630ecabb461691478e7a0370ce9d6f095f4150a5eeb939cf4a1a171da37968760
+  data.tar.gz: a0b551cbc889e2f5c45df6185afd80f90c3437a9cba1cb9f74c8e05d58dfcd6bb52f87aba87bd51a3f230899c5355cb778205b93ef3335ff9995d7cd860d1f7c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,33 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-05-26 17:59:51 +0200 using RuboCop version 0.55.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Lint/ImplicitStringConcatenation:
+  Exclude:
+    - 'bittrex_ruby.gemspec'
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 17
+
+# Offense count: 4
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 119
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/deep_symbolize.rb'
+
+# Offense count: 11
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 105

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at maxime@cyberwatch.fr. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bittrex_ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    bittrex_ruby (1.0.0)
+      addressable
+      json
+      openssl
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.1.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    openssl (2.1.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bittrex_ruby!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,90 @@
+# BittrexRuby
+
+This gem provides a wrapper for Bittrex.com Public/Account/Market APIs.
+
+It can for instance place buy/sell orders for you.
+
+[![Build Status](https://travis-ci.org/tarraschk/bittrex_ruby.svg?branch=master)](https://travis-ci.org/tarraschk/bittrex_ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bittrex_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bittrex_ruby
+
+## Usage
+
+
+### Load the gem
+```
+require 'bittrex_ruby'
+```
+
+### Setup your Bittrex API keys
+
+```
+BittrexRuby.setup do |config|
+  config.key = 'BITTREX_KEY'
+  config.secret = 'BITTREX_SECRET'
+end
+```
+
+### Use the gem
+
+This gem methods are named after the official Bittrex v1.1 API Documentation: https://support.bittrex.com/hc/en-us/articles/115003723911-Developer-s-Guide-API
+
+```
+# Public API
+BittrexRuby.getmarkets
+BittrexRuby.getcurrencies
+BittrexRuby.getticker('btc-eth')
+BittrexRuby.getmarketsummaries
+BittrexRuby.getmarketsummary('btc-eth')
+BittrexRuby.getorderbook('btc-eth', 'buy')
+BittrexRuby.getmarkethistory('btc-eth')
+
+# Market API
+BittrexRuby.buylimit('btc-eth', 1.0, 1.0)
+BittrexRuby.selllimit('btc-eth', 1.0, 1.0)
+BittrexRuby.cancel('09aa5bb6-8232-41aa-9b78-a5a1093e0211')
+BittrexRuby.getopenorders
+BittrexRuby.getopenorders('btc-eth')
+
+# Account API
+BittrexRuby.getbalances
+BittrexRuby.getbalance('BTC')
+BittrexRuby.getdepositaddress('BTC')
+BittrexRuby.withdraw('EAC', 20.40, 'EAC_ADDRESS')
+BittrexRuby.withdraw('EAC', 20.40, 'EAC_ADDRESS', 'PAYMENTID')
+BittrexRuby.getorder('0cb4c4e4-bdc7-4e13-8c13-430e587d2cc1')
+BittrexRuby.getorderhistory
+BittrexRuby.getorderhistory('btc-eth')
+BittrexRuby.getwithdrawalhistory
+BittrexRuby.getwithdrawalhistory('btc')
+BittrexRuby.getdeposithistory
+BittrexRuby.getdeposithistory('btc')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tarraschk/bittrex_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the BittrexRuby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tarraschk/bittrex_ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'bittrex_ruby'
+
+# 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/bittrex_ruby.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bittrex_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'bittrex_ruby'
+  spec.version = BittrexRuby::VERSION
+  spec.authors = ['Maxime Alay-Eddine']
+  spec.email = ['maxime.alayeddine@gmail.com']
+
+  spec.summary = ''"
+  Provides a wrapper for Bittrex.com Public/Account/Market APIs.
+  "''
+  spec.description = ''"
+  Provides a wrapper for Bittrex.com Public/Account/Market APIs.
+  Supports placing buy/sell orders.
+  "''
+  spec.homepage = 'https://github.com/tarraschk/bittrex_ruby'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'addressable'
+  spec.add_dependency 'json'
+  spec.add_dependency 'openssl'
+  spec.add_dependency 'rest-client'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/bittrex_ruby/version.rb

@@ -0,0 +1,3 @@
+module BittrexRuby
+  VERSION = '1.0.0'.freeze
+end

data/lib/bittrex_ruby.rb

@@ -0,0 +1,144 @@
+require 'bittrex_ruby/version'
+require 'rest-client'
+require 'openssl'
+require 'addressable/uri'
+require 'deep_symbolize'
+require 'json'
+
+# Gem to use Bittrex API
+module BittrexRuby
+  class << self
+      attr_accessor :configuration
+  end
+
+  def self.setup
+    @configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  # Handles the Bittrex API keys
+  class Configuration
+    attr_accessor :key, :secret
+
+    def initialize
+      @key = ''
+      @secret = ''
+    end
+  end
+
+  # Public API
+  def self.getmarkets
+    get 'public', 'getmarkets'
+  end
+
+  def self.getcurrencies
+    get 'public', 'getcurrencies'
+  end
+
+  def self.getticker(market)
+    get 'public', 'getticker', market: market
+  end
+
+  def self.getmarketsummaries
+    get 'public', 'getmarketsummaries'
+  end
+
+  def self.getmarketsummary(market)
+    get 'public', 'getmarketsummary', market: market
+  end
+
+  def self.getorderbook(market, type)
+    get 'public', 'getorderbook', market: market, type: type
+  end
+
+  def self.getmarkethistory(market)
+    get 'public', 'getmarkethistory', market: market
+  end
+
+  # Market API
+  def self.buylimit(market, quantity, rate)
+    get_signed 'market', 'buylimit', market: market,
+                                     quantity: quantity, rate: rate
+  end
+
+  def self.selllimit(market, quantity, rate)
+    get_signed 'market', 'selllimit', market: market,
+                                      quantity: quantity, rate: rate
+  end
+
+  def self.cancel(uuid)
+    get_signed 'market', 'cancel', uuid: uuid
+  end
+
+  def self.getopenorders(market = nil)
+    get_signed 'market', 'getopenorders', market: market
+  end
+
+  # Account API
+  def self.getbalances
+    get_signed 'account', 'getbalances'
+  end
+
+  def self.getbalance(currency)
+    get_signed 'account', 'getbalance', currency: currency
+  end
+
+  def self.getdepositaddress(currency)
+    get_signed 'account', 'getdepositaddress', currency: currency
+  end
+
+  def self.withdraw(currency, quantity, address, paymentid = nil)
+    get_signed 'account', 'withdraw',
+               currency: currency, quantity: quantity,
+               address: address, paymentid: paymentid
+  end
+
+  def self.getorder(uuid)
+    get_signed 'account', 'getorder', uuid: uuid
+  end
+
+  def self.getorderhistory(market = nil)
+    get_signed 'account', 'getorderhistory', market: market
+  end
+
+  def self.getwithdrawalhistory(currency = nil)
+    get_signed 'account', 'getwithdrawalhistory', currency: currency
+  end
+
+  def self.getdeposithistory(currency = nil)
+    get_signed 'account', 'getdeposithistory', currency: currency
+  end
+
+  class << self
+      def resource
+        RestClient::Resource.new('https://bittrex.com/api/v1.1/')
+      end
+
+      def get(api_group, action, params = {})
+        res = resource[api_group + '/' + action].get params: params.compact
+        res_hash res
+      end
+
+      def get_signed(api_group, action, params = {})
+        params[:nonce] = Time.now.to_i
+        params[:apikey] = configuration.key
+
+        # Build Query parameters string
+        params_query = params.compact.map { |k, v| "#{k}=#{v}" }.join('&')
+        uri = resource[api_group + '/' + action + '?' + params_query]
+
+        res = uri.get apisign: create_sign(uri)
+        res_hash res
+      end
+
+      def create_sign(uri)
+        OpenSSL::HMAC.hexdigest('sha512', configuration.secret, uri.url)
+      end
+
+      def res_hash(res)
+        data = JSON.parse(res.body)
+        data.extend DeepSymbolizable
+        { data: data.deep_symbolize, res: res }
+      end
+  end
+end

data/lib/deep_symbolize.rb

@@ -0,0 +1,68 @@
+# Symbolizes all of hash's keys and subkeys.
+# Also allows for custom pre-processing of keys (e.g. downcasing, etc)
+# if the block is given:
+#
+# somehash.deep_symbolize { |key| key.downcase }
+#
+# Usage: either include it into global Hash class to make it available to
+#        to all hashes, or extend only your own hash objects with this
+#        module.
+#        E.g.:
+#        1) class Hash; include DeepSymbolizable; end
+#        2) myhash.extend DeepSymbolizable
+#
+# Source: https://github.com/ntamvl/poloniex_ruby/blob/master/lib/deep_symbolize.rb
+
+# Used to symbolize hashes
+module DeepSymbolizable
+  def deep_symbolize(&block)
+    method = self.class.to_s.downcase.to_sym
+    syms = DeepSymbolizable::Symbolizers
+    syms.respond_to?(method) ? syms.send(method, self, &block) : self
+  end
+
+  # Used to symbolize hashes
+  module Symbolizers
+    module_function
+
+    # the primary method - symbolizes keys of the given hash,
+    # preprocessing them with a block if one was given, and recursively
+    # going into all nested enumerables
+    def hash(hash, &block)
+      hash.each_with_object({}) do |(key, value), result|
+        # Recursively deep-symbolize subhashes
+        value = _recurse_(value, &block)
+
+        # Pre-process the key with a block if it was given
+        key = yield key if block_given?
+        # Symbolize the key string if it responds to to_sym
+        sym_key = begin
+                    key.to_sym
+                  rescue StandardError
+                    key
+                  end
+
+        # write it back into the result and return the updated hash
+        result[sym_key] = value
+      end
+    end
+
+    # walking over arrays and symbolizing all nested elements
+    def array(ary, &block)
+      ary.map { |v| _recurse_(v, &block) }
+    end
+
+    # handling recursion - any Enumerable elements (except String)
+    # is being extended with the module, and then symbolized
+    def _recurse_(value, &block)
+      if value.is_a?(Enumerable) && !value.is_a?(String)
+        # support for a use case without extended core Hash
+        unless value.class.include?(DeepSymbolizable)
+          value.extend DeepSymbolizable
+        end
+        value = value.deep_symbolize(&block)
+      end
+      value
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: bittrex_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Maxime Alay-Eddine
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "\n  Provides a wrapper for Bittrex.com Public/Account/Market APIs.\n
+  \ Supports placing buy/sell orders.\n  "
+email:
+- maxime.alayeddine@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bittrex_ruby.gemspec
+- lib/bittrex_ruby.rb
+- lib/bittrex_ruby/version.rb
+- lib/deep_symbolize.rb
+homepage: https://github.com/tarraschk/bittrex_ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Provides a wrapper for Bittrex.com Public/Account/Market APIs.
+test_files: []