kraken_ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba98315341ba3773c618f03b63eefc55b9a7b255
-  data.tar.gz: 2b6626102a0ca88bcb48cd0fdc2d1e0e4f873fcc
+  metadata.gz: 0ffb806d88019bc391138ea85eb78acf492209f6
+  data.tar.gz: 0025cc093da95c4bc0feffdc9a01417db570fab5
 SHA512:
-  metadata.gz: 69b20b69a1342f2be7e5145a71eca590f7ae450c347e7da78301f5ae033bf5fb61422b1ed1e6ffe6db71a3000f3f98c97065c2270b2826c838d0150b0a3d5e7b
-  data.tar.gz: cbd54f67a9585601122bce841e20a97e13ccec70159f3912a6b1d6d47f0bb040d2d92b2c3ca0f9cbf50d16ba3c08431fcdfd0aacc91781636cb5b911794e24fc
+  metadata.gz: ddeaf904124a47f3c3b8d01ef4563e2af9f7b338d5f9358b7e669006a83027b9206c2686b9a0fd441983e8d43a6cb2b83925416d0ac8a0b641437163880a395a
+  data.tar.gz: 363d2daa1af9fe2ff36ce681fffd7a9ad670b364392352c31bd441b54cfe73449e9000764968fd10f4844ee151ccfe15f3bc7075af828dd97e645b16b1e9fcb6

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    kraken_ruby (0.2.0)
+      hashie
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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
+  bundler (~> 1.3)
+  kraken_ruby!
+  rake
+  rspec

data/kraken_ruby.gemspec

@@ -20,6 +20,9 @@ Gem::Specification.new do |spec|
 
   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/client.rb

@@ -1,6 +1,8 @@
-require 'kraken_ruby/version'
 require 'httparty'
 require 'hashie'
+require 'Base64'
+require 'addressable/uri'
+
 
 module Kraken
   class Client
@@ -10,7 +12,7 @@ module Kraken
       @api_key      = api_key
       @api_secret   = api_secret
       @api_version  = options[:version] ||= '0'
-      @base_uri     = options[:base_uri] ||= 'https://api.kraken.com/'
+      @base_uri     = options[:base_uri] ||= 'https://api.kraken.com'
     end
 
     ###########################
@@ -50,16 +52,121 @@ module Kraken
     end
 
     def get_public(method, opts={})
-      url = @base_uri + @api_version + '/public/' + method
+      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: ##########
-    ### Coming in Next Release ####
-    ###############################
+    ######################
+    ##### 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 (Still experimental!) ####
+
+    def add_order(opts={})
+      required_opts = %w{pair, type, ordertype, volume}
+      opts.keys.each do |key|
+        unless required_opts.include?(1) 
+          raise "Required options, not given. Input must include #{required_opts}"
+        end
+      end
+      post_private 'AddOrder', 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
+
+      def nonce
+        Time.now.to_i.to_s.ljust(16,'0')
+      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.encode64(OpenSSL::HMAC.digest('sha512', key, message)).split.join # to remove '/n' inserted into signature by HMAc
+      end
+
+      def url_path(method)
+        '/' + @api_version + '/private/' + method
+      end
 
   end
 end

data/lib/kraken_ruby/version.rb

@@ -1,3 +1,3 @@
 module KrakenRuby
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/client_spec.rb

@@ -0,0 +1,61 @@
+require 'kraken_ruby'
+
+describe Kraken::Client do
+
+	# YOU MUST REPLACE THE PLACEHOLDERS BELOW WITH YOUR API KEYS 
+	# TO TEST PRIVATE DATA QUERIES. PRIVATE TESTS WILL FAIL OTHERWISE
+
+	API_KEY = 'ADD YOUR KEY HERE'
+	API_SECRET = 'ADD YOUR SECRET HERE'
+
+	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
+	end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kraken_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexander Leishman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-22 00:00:00.000000000 Z
+date: 2014-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: 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'
 description: '"Wrapper for Kraken Exchange API"'
 email:
 - leishman3@gmail.com
@@ -61,13 +103,17 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- kraken_ruby-0.1.0.gem
+- kraken_ruby-0.2.0.gem
 - kraken_ruby.gemspec
 - lib/kraken_ruby.rb
 - lib/kraken_ruby/client.rb
 - lib/kraken_ruby/version.rb
+- spec/client_spec.rb
 homepage: https://www.kraken.com/help/api
 licenses:
 - MIT
@@ -92,4 +138,5 @@ rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: '"Wrapper for Kraken Exchange API"'
-test_files: []
+test_files:
+- spec/client_spec.rb