kraken_ruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ffb806d88019bc391138ea85eb78acf492209f6
-  data.tar.gz: 0025cc093da95c4bc0feffdc9a01417db570fab5
+  metadata.gz: ec8b50b8dc92dd736d696e55e0c5a6d9d053afc0
+  data.tar.gz: 93cd06c2b0f5985a6322290d4500238e27103a42
 SHA512:
-  metadata.gz: ddeaf904124a47f3c3b8d01ef4563e2af9f7b338d5f9358b7e669006a83027b9206c2686b9a0fd441983e8d43a6cb2b83925416d0ac8a0b641437163880a395a
-  data.tar.gz: 363d2daa1af9fe2ff36ce681fffd7a9ad670b364392352c31bd441b54cfe73449e9000764968fd10f4844ee151ccfe15f3bc7075af828dd97e645b16b1e9fcb6
+  metadata.gz: 076941c2f85cf77902c745bea8555bae9f5a607167038ffe6aabb1b3ccb6d0e168f707ff1c554296c316734ecddd942bb57e2946e4bbf9618154786c48b69f40
+  data.tar.gz: 3ed194a84dddc2319d67dc509a84a6fc03c6e667f9a3fa9f6b20022f2247c01e0545bb492d182629f833bc50181331d74ad4d5b9303df809b904f5a55ddaaa20

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in kraken_ruby.gemspec
 gemspec
+gem 'httparty'
+gem 'hashie'

data/Gemfile.lock

@@ -2,12 +2,14 @@ PATH
   remote: .
   specs:
     kraken_ruby (0.2.0)
+      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)
@@ -30,6 +32,8 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.3)
+  hashie
+  httparty
   kraken_ruby!
   rake
   rspec

data/LICENSE.txt

@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,22 @@
 # KrakenRuby
 
-TODO: Write a gem description
+### 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
 
@@ -18,7 +34,154 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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)
+```
 
 ## Contributing
 
@@ -26,4 +189,4 @@ TODO: Write usage instructions here
 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
+5. Create new Pull Request

data/lib/kraken_ruby/client.rb

@@ -161,7 +161,7 @@ module Kraken
       end
 
       def generate_hmac(key, message)
-        Base64.encode64(OpenSSL::HMAC.digest('sha512', key, message)).split.join # to remove '/n' inserted into signature by HMAc
+        Base64.strict_encode64(OpenSSL::HMAC.digest('sha512', key, message))
       end
 
       def url_path(method)

data/lib/kraken_ruby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kraken_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alexander Leishman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,7 +101,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -109,6 +108,7 @@ files:
 - Rakefile
 - kraken_ruby-0.1.0.gem
 - kraken_ruby-0.2.0.gem
+- kraken_ruby-0.2.1.gem
 - kraken_ruby.gemspec
 - lib/kraken_ruby.rb
 - lib/kraken_ruby/client.rb

data/.gitignore

@@ -1 +0,0 @@
-kraken.key