bitfex 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48dee944d055d0fc34b02b5274318b5a29e8ba90
+  data.tar.gz: ce71b2da754d0fd723f43ecbb13bda6de494ea68
+SHA512:
+  metadata.gz: b7a21692f5e32252b1d5532d937b2b7b899cf36a24d281859a1d17016ae7f26256e69fd530829e770677bb00b6df079446a02fd6789077a625b25fe0537ab668
+  data.tar.gz: 4a502dbc78d54f8979274a3bdbfee6690b91753e9dfb88fc1ad1b430d5be6088b68b9a7efdf6551575433d2ef75df1cace0c31f46042578781d6efac7195424d

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+/.bundle

data/.travis.yml

@@ -0,0 +1,44 @@
+# Available ruby versions: http://rubies.travis-ci.org/
+
+language: ruby
+
+os:
+  - linux
+  - osx
+
+rvm:
+  - "2.0.0"
+  - "2.1" # latest 2.1.x
+  - "2.2.5"
+  - "2.3.3"
+  - "2.4.0"
+  - "ruby-head"
+  - "jruby-9.0.5.0"
+  - "jruby-9.1.5.0"
+  - "jruby-head"
+
+cache: bundler
+
+script:
+  - bundle exec rake test
+
+before_install:
+  - gem update --system
+  # bundler installation needed for jruby-head
+  # https://github.com/travis-ci/travis-ci/issues/5861
+  - gem install bundler
+
+# Travis OS X support is pretty janky. These are some hacks to include tests
+# only on versions that actually work.
+# (last tested: 2016-11)
+matrix:
+  # exclude: {}
+  # include: {}
+
+  allow_failures:
+    - rvm: 'ruby-head'
+
+  # return results as soon as mandatory versions are done
+  fast_finish: true
+
+sudo: false

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec name: 'bitfex'
+
+group :test do
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    bitfex (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    hashdiff (0.3.7)
+    minitest (5.11.3)
+    public_suffix (3.0.2)
+    rake (12.3.0)
+    safe_yaml (1.0.4)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bitfex!
+  minitest (~> 5.11)
+  rake
+  webmock (~> 2.0)
+
+BUNDLED WITH
+   1.13.6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 BitFex.Trade
+
+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,25 @@
+# BitFex API for ruby
+
+Simple implementation of BitFex.Trade API for ruby.
+
+# Documentation
+
+## Init
+
+```ruby
+require 'bitfex'
+
+client = Bitfex::Api.new()
+# make auth
+client.auth('user@example.com', 'password')
+# call API methods
+client.balances # => {'BTC' => 15.0}
+```
+
+## Methods
+
+Methods documentation could be found in source =/
+
+# Legal
+
+Released under the MIT License: https://opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/bitfex.gemspec

@@ -0,0 +1,20 @@
+require './lib/bitfex/version'
+
+Gem::Specification.new do |s|
+  s.name                  = 'bitfex'
+  s.version               = Bitfex::VERSION
+  s.date                  = '2018-02-25'
+  s.description           = 'API wrapper for BitFex.Trade cryptocurrency stock exchange'
+  s.summary               = 'API wrapper for BitFex.Trade'
+  s.authors               = ['BitFex.Trade']
+  s.email                 = 'support@bitfex.trade'
+  s.files                 = `git ls-files -z`.split("\0")
+  s.test_files            = `git ls-files -z test/`.split("\0")
+  s.homepage              = 'https://bitfex.trade'
+  s.extra_rdoc_files      = ['README.md']
+  s.license               = 'MIT'
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.add_development_dependency('webmock', '~> 2.0')
+  s.add_development_dependency('minitest', '~> 5.11')
+end

data/lib.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+class BitfexApi
+  class AuthError < StandardError; end
+
+  # @param server_url [String] URL of the main server
+  def initialize(server_url: "https://bitfex.trade")
+    @_server_url = server_url
+  end
+
+  # @return [String] URL of the server
+  def server_url
+    @_server_url
+  end
+
+  # @param url [String] set URL of the server
+  def server_url=(url)
+    @_server_url = url
+  end
+
+  # Get token for API operations
+  # @param email [String] email
+  # @param password [String] password
+  def auth(email, password)
+    body = request_post("/auth", auth: { email: email, password: password })
+    return @token = body["jwt"] if body["jwt"]
+    raise AuthError.new
+  end
+
+  # Return account balances
+  # @return [Hash<String, Fixnum>] balances
+  def balances
+    response = request_get("/api/v1/user")
+    raise StandardError.new(response["errors"].to_json) unless response["success"]
+    response["balances"]
+  end
+
+  # Return list of orders for all pairs
+  # @return [Array<Hash>] list of orders (id, pair, amount, price, operation, completed, updated)
+  def orders_list
+    response = request_get("/api/v1/orders")
+    raise StandardError.new(response["errors"].to_json) unless response["success"]
+    response["orders"]
+  end
+
+  # Return list of my orders
+  # @return [Array<Hash>] list of my orders (id, pair, amount, price, operation, completed, updated)
+  def my_orders
+    response = request_get("/api/v1/orders/my")
+    raise StandardError.new(response["errors"].to_json) unless response["success"]
+    response["orders"]
+  end
+
+  # Delete order by id
+  # @param id [Fixnum] order ID
+  # @return TrueClass
+  # @raise StandardError(error json) if response not success
+  def delete_order(id)
+    response = request_delete("/api/v1/orders/#{id}")
+    raise StandardError.new(response["errors"].to_json) unless response["success"]
+    true
+  end
+
+  # Create new order
+  # @param operation [String] operation - one of (buy/sell)
+  # @param pair [String] pair (like BTC_RUR)
+  # @param amount [Decimal] amount in normal units (roubles or bitcoins)
+  # @param price [Decimal] price in normal units (roubles or bitcoins)
+  def create_order(operation, pair, amount, price)
+    response = request_post(
+      "/api/v1/orders",
+      order: {
+        pair: pair,
+        operation: operation,
+        amount: amount,
+        price: price
+      }
+    )
+    raise StandardError.new(response["error"].to_json) unless response["success"]
+
+    true
+  end
+
+  attr_reader :btc_rate, :token, :my_orders_list, :balance
+
+  private
+
+  def request_post(endpoint, body)
+    request(endpoint, Net::HTTP::Post, body)
+  end
+
+  def request_delete(endpoint, body = nil)
+    request(endpoint, Net::HTTP::Delete, body)
+  end
+
+  def request_get(endpoint)
+    request(endpoint, Net::HTTP::Get)
+  end
+
+  def request(endpoint, klass, body = nil)
+    url = @_server_url + endpoint
+    uri = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = uri.port == 443
+
+    request = klass.new(uri.request_uri, "Content-Type" => "application/json")
+
+    request.add_field("Authorization", "Bearer #{token}") if token
+    request.body = JSON.dump(body) if body
+    response = http.request(request)
+    JSON.parse(response.body || "{}")
+  end
+end

data/lib/bitfex.rb

@@ -0,0 +1,6 @@
+require './lib/bitfex/version'
+require './lib/bitfex/errors'
+require './lib/bitfex/api'
+
+module Bitfex
+end

data/lib/bitfex/api.rb

@@ -0,0 +1,116 @@
+require 'json'
+require 'net/http'
+
+module Bitfex
+  class Api
+    attr_accessor :token
+
+    # @param server_url [String] URL of the main server
+    def initialize(server_url: 'https://bitfex.trade')
+      @_server_url = server_url
+    end
+
+    # @return [String] server url
+    def server_url
+      @_server_url
+    end
+
+    # @param url [String] set URL of the server
+    def server_url=(url)
+      @_server_url = url
+    end
+
+    # Get token for API operations
+    # @param email [String] email
+    # @param password [String] password
+    def auth(email, password)
+      body = request_post('/auth', auth: { email: email, password: password })
+      return @token = body['jwt'] if body['jwt']
+      raise AuthError.new
+    end
+
+    # Return account balances
+    # @return [Hash<String, Fixnum>] balances
+    def balances
+      response = request_get('/api/v1/user')
+      raise ApiError.new(response['errors'].to_json) unless response['success']
+      response['balances']
+    end
+
+    # Return list of orders for all pairs
+    # @return [Array<Hash>] list of orders (id, pair, amount, price, operation, completed, updated)
+    def orders_list
+      response = request_get('/api/v1/orders')
+      raise ApiError.new(response['errors'].to_json) unless response['success']
+      response['orders']
+    end
+
+    # Return list of my orders
+    # @return [Array<Hash>] list of my orders (id, pair, amount, price, operation, completed, updated)
+    def my_orders
+      response = request_get('/api/v1/orders/my')
+      raise ApiError.new(response['errors'].to_json) unless response['success']
+      response['orders']
+    end
+
+    # Delete order by id
+    # @param id [Fixnum] order ID
+    # @return [TrueClass]
+    # @raise ApiError(error_json) if response not success
+    def delete_order(id)
+      response = request_delete("/api/v1/orders/#{id}")
+      raise ApiError.new(response['errors'].to_json) unless response['success']
+      true
+    end
+
+    # Create new order
+    # @param operation [String] operation - one of (buy/sell)
+    # @param pair [String] pair (for example: BTC_RUR)
+    # @param amount [Decimal] amount in normal units (roubles or bitcoins)
+    # @param price [Decimal] price in normal units (roubles or bitcoins)
+    # @return [TrueClass]
+    # @raise ApiError(error_json) if response not success
+    def create_order(operation, pair, amount, price)
+      response = request_post(
+        '/api/v1/orders',
+        order: {
+          pair: pair,
+          operation: operation,
+          amount: amount,
+          price: price
+        }
+      )
+      raise ApiError.new(response['error'].to_json) unless response['success']
+
+      true
+    end
+
+    private
+
+    def request_post(endpoint, body)
+      request(endpoint, Net::HTTP::Post, body)
+    end
+
+    def request_delete(endpoint, body = nil)
+      request(endpoint, Net::HTTP::Delete, body)
+    end
+
+    def request_get(endpoint)
+      request(endpoint, Net::HTTP::Get)
+    end
+
+    def request(endpoint, klass, body = nil)
+      url = @_server_url + endpoint
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.port == 443
+
+      request = klass.new(uri.request_uri, 'Content-Type' => 'application/json')
+
+      request.add_field('Authorization', "Bearer #{token}") if token
+      request.body = JSON.dump(body) if body
+      response = http.request(request)
+      JSON.parse(response.body || '{}')
+    end
+  end
+end

data/lib/bitfex/errors.rb

@@ -0,0 +1,4 @@
+module Bitfex
+  class AuthError < StandardError; end
+  class ApiError < StandardError; end
+end

data/lib/bitfex/version.rb

@@ -0,0 +1,8 @@
+module Bitfex
+  VERSION_INFO = [1, 0, 0].freeze
+  VERSION = VERSION_INFO.map(&:to_s).join('.').freeze
+
+  def self.version
+    VERSION
+  end
+end

data/test/test_bitfex.rb

@@ -0,0 +1,153 @@
+require 'test_helper'
+
+require 'bitfex'
+
+class BitfexTest < Minitest::Test
+  def test_initialize
+    client = Bitfex::Api.new(server_url: 'http://localhost/')
+    assert_equal 'http://localhost/', client.server_url
+  end
+
+  def test_default_server_url
+    client = Bitfex::Api.new
+    assert_equal 'https://bitfex.trade', client.server_url
+  end
+
+  def test_set_server_url
+    client = Bitfex::Api.new
+    client.server_url = 'https://google.com/'
+    assert_equal 'https://google.com/', client.server_url
+  end
+
+  def test_auth_success
+    stub_request(:post, 'https://bitfex.trade/auth')
+      .with(body: '{"auth":{"email":"user@example.com","password":"123"}}')
+      .to_return(status: 200, body: '{"jwt":"token"}')
+
+    client = Bitfex::Api.new
+    assert_equal 'token', client.auth('user@example.com', '123')
+  end
+
+  def test_auth_failure
+    stub_request(:post, 'https://bitfex.trade/auth')
+      .with(body: '{"auth":{"email":"user@example.com","password":"123"}}')
+      .to_return(status: 404, body: '{}')
+
+    assert_raises Bitfex::AuthError do
+      client = Bitfex::Api.new
+      client.auth('user@example.com', '123')
+    end
+  end
+
+  def test_balances_success
+    stub_request(:get, "https://bitfex.trade/api/v1/user")
+      .with(headers: { 'Authorization' => 'Bearer 123' })
+      .to_return(status: 200, body: '{"success":true,"balances":{"BTC":10.5}}')
+
+    client = Bitfex::Api.new
+    client.token = '123'
+    assert_equal({'BTC' => 10.5}, client.balances)
+  end
+
+  def test_balances_failure
+    stub_request(:get, "https://bitfex.trade/api/v1/user")
+      .with(headers: { 'Authorization' => 'Bearer 123' })
+      .to_return(status: 403, body: '{"success":false,"errors":["TEST"]}')
+
+    assert_raises Bitfex::ApiError do
+      client = Bitfex::Api.new
+      client.token = '123'
+      client.balances
+    end
+  end
+
+  def test_orders_list_success
+    stub_request(:get, "https://bitfex.trade/api/v1/orders")
+      .with(headers: { 'Authorization' => 'Bearer 123' })
+      .to_return(status: 200, body: '{"success":true,"orders":[{"id":1}]}')
+
+    client = Bitfex::Api.new
+    client.token = '123'
+    assert_equal([{'id' => 1}], client.orders_list)
+  end
+
+  def test_orders_list_faulure
+    stub_request(:get, "https://bitfex.trade/api/v1/orders")
+      .with(headers: { 'Authorization' => 'Bearer 123' })
+      .to_return(status: 403, body: '{"success":false,"errors":["TEST"]}')
+
+    assert_raises Bitfex::ApiError do
+      client = Bitfex::Api.new
+      client.token = '123'
+      client.orders_list
+    end
+  end
+
+  def test_my_orders_success
+    stub_request(:get, "https://bitfex.trade/api/v1/orders/my")
+      .with(headers: { 'Authorization' => 'Bearer 123' })
+      .to_return(status: 200, body: '{"success":true,"orders":[{"id":1}]}')
+
+    client = Bitfex::Api.new
+    client.token = '123'
+    assert_equal([{'id' => 1}], client.my_orders)
+  end
+
+  def test_my_orders_faulure
+    stub_request(:get, "https://bitfex.trade/api/v1/orders/my")
+      .with(headers: { 'Authorization' => 'Bearer 123' })
+      .to_return(status: 403, body: '{"success":false,"errors":["TEST"]}')
+
+    assert_raises Bitfex::ApiError do
+      client = Bitfex::Api.new
+      client.token = '123'
+      client.my_orders
+    end
+  end
+
+  def test_delete_order_success
+    stub_request(:delete, 'https://bitfex.trade/api/v1/orders/1')
+      .with(headers: { 'Authorization' => 'Bearer 123' })
+      .to_return(status: 200, body: '{"success":true}')
+
+    client = Bitfex::Api.new
+    client.token = '123'
+    assert_equal true, client.delete_order(1)
+  end
+
+  def test_delete_order_failure
+    stub_request(:delete, 'https://bitfex.trade/api/v1/orders/1')
+      .with(headers: { 'Authorization' => 'Bearer 123' })
+      .to_return(status: 400, body: '{"success":false,"errors":["TEST"]}')
+
+    assert_raises Bitfex::ApiError do
+      client = Bitfex::Api.new
+      client.token = '123'
+      client.delete_order(1)
+    end
+  end
+
+  def test_create_order_success
+    stub_request(:post, 'https://bitfex.trade/api/v1/orders')
+      .with(body: "{\"order\":{\"pair\":\"BTC_RUR\",\"operation\":\"buy\",\"amount\":1.0,\"price\":60000.0}}",
+            headers: { 'Authorization' => 'Bearer 123' })
+      .to_return(status: 200, body: '{"success":true}')
+
+    client = Bitfex::Api.new
+    client.token = '123'
+    assert_equal true, client.create_order(:buy, 'BTC_RUR', 1.0, 600_00.0)
+  end
+
+  def test_create_order_failure
+    stub_request(:post, 'https://bitfex.trade/api/v1/orders')
+      .with(body: "{\"order\":{\"pair\":\"BTC_RUR\",\"operation\":\"buy\",\"amount\":1.0,\"price\":60000.0}}",
+            headers: { 'Authorization' => 'Bearer 123' })
+      .to_return(status: 403, body: '{"success":false,"errors":["TEST"]}')
+
+    assert_raises Bitfex::ApiError do
+      client = Bitfex::Api.new
+      client.token = '123'
+      client.create_order(:buy, 'BTC_RUR', 1.0, 600_00.0)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'webmock/minitest'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: bitfex
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- BitFex.Trade
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+description: API wrapper for BitFex.Trade cryptocurrency stock exchange
+email: support@bitfex.trade
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bitfex.gemspec
+- lib.rb
+- lib/bitfex.rb
+- lib/bitfex/api.rb
+- lib/bitfex/errors.rb
+- lib/bitfex/version.rb
+- test/test_bitfex.rb
+- test/test_helper.rb
+homepage: https://bitfex.trade
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: API wrapper for BitFex.Trade
+test_files:
+- test/test_bitfex.rb
+- test/test_helper.rb