kraken_ruby 0.4.1 → 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af88f54624c729cd704d10d7e489ab9a05c8d9c7
+  data.tar.gz: 8f476f022892acf97687f39b6342ce001baf4fb9
+SHA512:
+  metadata.gz: 0a9e886717cbdee05f41b87bafc21c4d3e94616ac5195c1d4991672a8343d627876afeb10abd11def56212baed99462cb6a353a53a3f802554e36f43a6fa2b29
+  data.tar.gz: 27bb01c561250b27a2c0416192cf4440b2e54e7e9fd6276ba13b9865959fa4f2c52c6aba2a881830f00374059bf266c9576d7506e1a7d24d28e72eeac2929f65

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kraken_ruby.gemspec
+gemspec
+gem 'httparty'
+gem 'hashie'
+gem 'addressable'

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    kraken_ruby (0.4.1)
+      addressable
+      hashie
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    diff-lcs (1.2.5)
+    hashie (2.0.5)
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    multi_xml (0.5.5)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  addressable
+  bundler (~> 1.3)
+  hashie
+  httparty
+  kraken_ruby!
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexander Leishman
+
+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,216 @@
+# KrakenRuby
+
+### IMPORTANT
+
+This gem is currently built to only query data. There is an experimental ```add_order``` trading method that can be used at **your own risk**. Please thoroughly vet everything in the code for yourself before using this gem to buy, sell, or move any of your assets.
+
+PLEASE submit an issue or pull request if you notice any bugs, security holes, or potential improvements.
+
+### Description
+
+This gem is a wrapper for the [Kraken Digital Asset Trading Platform](https://www.kraken.com) API. Official documentation from Kraken can be found [here](https://www.kraken.com/help/api).
+
+The current version (0.2.0) can be used to query public and private market data. Private data queries require use of your account API keys.
+
+### Pending Future Updates
+
+- Solid trade execution functionality
+- More comprehensive test suite for methods requiring authentication (using VCR perhaps)
+- More comprehensive documentation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kraken_ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kraken_ruby
+
+## Usage
+
+Create a Kraken client:
+
+```ruby
+API_KEY = '3bH+M/nLp......'
+API_SECRET = 'wQG+7Lr9b.....'
+
+kraken = Kraken::Client.new(API_KEY, API_SECRET)
+
+time = kraken.server_time
+time.unixtime #=> 1393056191
+```
+
+### Public Data Methods
+
+#### Server Time
+
+This functionality is provided by Kraken to to aid in approximating the skew time between the server and client.
+
+```ruby
+time = kraken.server_time
+
+time.unixtime #=> 1393056191
+time.rfc1123 #=> "Sat, 22 Feb 2014 08:28:04 GMT"
+```
+
+#### Asset Info
+
+Returns the assets that can be traded on the exchange. This method can be passed ```info```, ```aclass``` (asset class), and ```asset``` options. An example below is given for each:
+
+```ruby
+kraken.assets
+```
+
+#### Asset Pairs
+
+```ruby
+pairs = kraken.asset_pairs
+```
+
+#### Ticker Information
+
+```ruby
+ticker_data = kraken.ticker('XLTCXXDG, ZUSDXXVN')
+```
+
+#### Order Book
+
+Get market depth information for given asset pairs
+
+```ruby
+depth_data = kraken.order_book('LTCXRP')
+```
+
+#### Trades
+
+Get recent trades
+
+```ruby
+trades = kraken.trades('LTCXRP')
+```
+
+#### Spread
+
+Get spread data for a given asset pair
+
+```ruby
+spread = kraken.spread('LTCXRP')
+```
+
+### Private Data Methods
+
+#### Balance
+
+Get account balance for each asset
+Note: Rates used for the floating valuation is the midpoint of the best bid and ask prices
+
+```ruby
+balance = kraken.balance
+```
+
+#### Trade Balance
+
+Get account trade balance
+
+```ruby
+trade_balance = kraken.trade_balance
+```
+
+#### Open Orders
+
+```ruby
+open_orders = kraken.open_orders
+```
+
+#### Query Orders
+
+See all orders
+
+```ruby
+orders = kraken.query_orders
+```
+
+#### Trades History
+
+Get array of all trades
+
+```ruby
+trades = kraken.trade_history
+```
+
+#### Query Trades
+
+**Input:** Comma delimited list of transaction (tx) ids
+
+```ruby
+trades = kraken.query_trades(tx_ids)
+```
+
+#### Open Positions
+
+**Input:** Comma delimited list of transaction (tx) ids
+
+```ruby
+positions = kraken.open_positions(tx_ids)
+```
+
+#### Ledgers Info
+
+```ruby
+ledgers = kraken.ledgers_info
+```
+
+#### Ledgers Info
+
+**Input:** Comma delimited list of ledger ids
+
+```ruby
+ledgers = kraken.query_ledgers(ledger_ids)
+```
+
+#### Trade Volume
+
+**Input:** Comma delimited list of asset pairs
+
+```ruby
+asset_pairs = 'XLTCXXDG, ZEURXXDG'
+volume = kraken.query_ledgers(asset_pairs)
+```
+
+### Adding and Cancelling Orders
+
+#### Add Order
+
+There are 4 required parameters for buying an order. The example below illustrates the most basic order. Please see the [Kraken documentation](https://www.kraken.com/help/api#add-standard-order) for the parameters required for more advanced order types.
+```ruby
+# buying 0.01 XBT (bitcoin) for XRP (ripple) at market price
+opts = {
+  pair: 'XBTXRP',
+  type: 'buy',
+  ordertype: 'market',
+  volume: 0.01
+}
+
+kraken.add_order(opts)
+
+```
+
+#### Cancel Order
+
+```ruby
+kraken.cancel_order("UKIYSP-9VN27-AJWWYC")
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/kraken_ruby.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kraken_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kraken_ruby"
+  spec.version       = KrakenRuby::VERSION
+  spec.authors       = ["Alexander Leishman"]
+  spec.email         = ["leishman3@gmail.com"]
+  spec.description   = %q{"Wrapper for Kraken Exchange API"}
+  spec.summary       = %q{"Wrapper for Kraken Exchange API"}
+  spec.homepage      = "https://www.kraken.com/help/api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "httparty"
+  spec.add_dependency "hashie"
+  spec.add_dependency "addressable"
+end

data/lib/kraken_ruby.rb

@@ -0,0 +1,2 @@
+require "kraken_ruby/version"
+require "kraken_ruby/client"

data/lib/kraken_ruby/client.rb

@@ -0,0 +1,181 @@
+require 'base64'
+require 'securerandom'
+require 'addressable/uri'
+require 'httparty'
+require 'hashie'
+
+module Kraken
+  class Client
+    include HTTParty
+
+    def initialize(api_key=nil, api_secret=nil, options={})
+      @api_key      = api_key
+      @api_secret   = api_secret
+      @api_version  = options[:version] ||= '0'
+      @base_uri     = options[:base_uri] ||= 'https://api.kraken.com'
+    end
+
+    ###########################
+    ###### Public Data ########
+    ###########################
+
+    def server_time
+      get_public 'Time'
+    end
+
+    def assets(opts={})
+      get_public 'Assets'
+    end
+
+    def asset_pairs(opts={})
+      get_public 'AssetPairs', opts
+    end
+
+    def ticker(pairs) # takes string of comma delimited pairs
+      opts = { 'pair' => pairs }
+      get_public 'Ticker', opts
+    end
+
+    def order_book(pair, opts={})
+      opts['pair'] = pair
+      get_public 'Depth', opts
+    end
+
+    def trades(pair, opts={})
+      opts['pair'] = pair
+      get_public 'Trades', opts
+    end
+
+    def spread(pair, opts={})
+      opts['pair'] = pair
+      get_public 'Spread', opts
+    end
+
+    def get_public(method, opts={})
+      url = @base_uri + '/' + @api_version + '/public/' + method
+      r = self.class.get(url, query: opts)
+      hash = Hashie::Mash.new(JSON.parse(r.body))
+      hash[:result]
+    end
+
+    ######################
+    ##### Private Data ###
+    ######################
+
+    def balance(opts={})
+      post_private 'Balance', opts
+    end
+
+    def trade_balance(opts={})
+      post_private 'TradeBalance', opts
+    end
+
+    def open_orders(opts={})
+      post_private 'OpenOrders', opts
+    end
+
+    def query_orders(opts={})
+      post_private 'QueryOrders', opts
+    end
+
+    def trade_history(opts={})
+      post_private 'TradesHistory', opts
+    end
+
+    def query_trades(tx_ids, opts={})
+      opts['txid'] = tx_ids
+      post_private 'QueryTrades', opts
+    end
+
+    def open_positions(tx_ids, opts={})
+      opts['txid'] = tx_ids
+      post_private 'OpenPositions', opts
+    end
+
+    def ledgers_info(opts={})
+      post_private 'Ledgers', opts
+    end
+
+    def query_ledgers(ledger_ids, opts={})
+      opts['id'] = ledger_ids
+      post_private 'QueryLedgers', opts
+    end
+
+    def trade_volume(asset_pairs)
+      opts['pair'] = asset_pairs
+      post_private 'TradeVolume', opts
+    end
+
+    #### Private User Trading ####
+
+    def add_order(opts={})
+      required_opts = %w{ pair type ordertype volume }
+      leftover = required_opts - opts.keys.map(&:to_s)
+      if leftover.length > 0
+        raise ArgumentError.new("Required options, not given. Input must include #{leftover}")
+      end
+      post_private 'AddOrder', opts
+    end
+
+    def cancel_order(txid)
+      opts = { txid: txid }
+      post_private 'CancelOrder', opts
+    end
+
+    #######################
+    #### Generate Signed ##
+    ##### Post Request ####
+    #######################
+
+    private
+
+      def post_private(method, opts={})
+        opts['nonce'] = nonce
+        post_data = encode_options(opts)
+
+        headers = {
+          'API-Key' => @api_key,
+          'API-Sign' => generate_signature(method, post_data, opts)
+        }
+
+        url = @base_uri + url_path(method)
+        r = self.class.post(url, { headers: headers, body: post_data }).parsed_response
+        r['error'].empty? ? r['result'] : r['error']
+      end
+
+      # Generate a 64-bit nonce where the 32 high bits come directly from the current
+      # timestamp and the low 32 bits are pseudorandom. We can't use a pure [P]RNG here
+      # because the Kraken API requires every request within a given session to use a
+      # monotonically increasing nonce value. This approach splits the difference.
+      def nonce
+        high_bits = Time.now.to_i << 32
+        low_bits  = SecureRandom.random_number(2 ** 32) & 0xffffffff
+        (high_bits | low_bits).to_s
+      end
+
+      def encode_options(opts)
+        uri = Addressable::URI.new
+        uri.query_values = opts
+        uri.query
+      end
+
+      def generate_signature(method, post_data, opts={})
+        key = Base64.decode64(@api_secret)
+        message = generate_message(method, opts, post_data)
+        generate_hmac(key, message)
+      end
+
+      def generate_message(method, opts, data)
+        digest = OpenSSL::Digest.new('sha256', opts['nonce'] + data).digest
+        url_path(method) + digest
+      end
+
+      def generate_hmac(key, message)
+        Base64.strict_encode64(OpenSSL::HMAC.digest('sha512', key, message))
+      end
+
+      def url_path(method)
+        '/' + @api_version + '/private/' + method
+      end
+  end
+end

data/lib/kraken_ruby/version.rb

@@ -0,0 +1,3 @@
+module KrakenRuby
+  VERSION = "0.4.2"
+end

data/spec/client_spec.rb

@@ -0,0 +1,68 @@
+require 'kraken_ruby'
+
+describe Kraken::Client do
+
+	# YOU MUST SET ENVIRONMENT VARIABLES KRAKEN_API_KEY AND
+  # KRAKEN_API_SECRET TO TEST PRIVATE DATA QUERIES. PRIVATE
+  # TESTS WILL FAIL OTHERWISE.
+
+  API_KEY    = ENV['KRAKEN_API_KEY']
+  API_SECRET = ENV['KRAKEN_API_SECRET']
+
+	before :each do
+		sleep 0.3 # to prevent rapidly pinging the Kraken server
+	end
+
+	let(:kraken){Kraken::Client.new(API_KEY, API_SECRET)}
+
+	context "public data" do
+		it "gets the proper server time" do
+			kraken_time = DateTime.parse(kraken.server_time.rfc1123)
+			utc_time = Time.now.getutc
+			expect(kraken_time.day).to eq utc_time.day
+			expect(kraken_time.hour).to eq utc_time.hour
+		end
+
+		it "gets list of tradeable assets" do
+			expect(kraken.assets).to respond_to :XLTC
+		end
+
+		it "gets list of asset pairs" do
+			expect(kraken.asset_pairs).to respond_to :XLTCXXDG
+		end
+
+		it "gets public ticker data for given asset pairs" do
+			result = kraken.ticker('XLTCXXDG, ZEURXXDG')
+			expect(result).to respond_to :XLTCXXDG
+			expect(result).to respond_to :ZEURXXDG
+		end
+
+		it "gets order book data for a given asset pair" do
+			order_book = kraken.order_book('XLTCXXDG')
+			expect(order_book.XLTCXXDG).to respond_to :asks
+		end
+
+		it "gets an array of trades data for a given asset pair" do
+			trades = kraken.trades('XLTCXXDG')
+			expect(trades.XLTCXXDG).to be_instance_of(Array)
+		end
+
+		it "gets an array of spread data for a given asset pair" do
+			spread = kraken.spread('XLTCXXDG')
+			expect(spread.XLTCXXDG).to be_instance_of(Array)
+		end
+	end
+
+	context "private data" do # More tests to come
+		it "gets the user's balance" do
+			expect(kraken.balance).to be_instance_of(Hash)
+		end
+
+    it "uses a 64 bit nonce" do
+      nonce = kraken.send :nonce
+      expect(nonce.to_i.size).to eq(8)
+      expect(nonce.to_i).to be_instance_of(Bignum)
+    end
+	end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kraken_ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Alexander Leishman