vault_of_satoshi 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1e875eb3e886544c86750cb12fb43185006a3d5
-  data.tar.gz: b5137743d6835cea4f328bc5db12438bc3ff818a
+  metadata.gz: 87632db2ffc03aab733bf817f47f678b08ed6348
+  data.tar.gz: 718ee0622641476f747bfde02bb1c5bf97133a32
 SHA512:
-  metadata.gz: 80af280d1bfc293b2b7fc611078e6cb279293cf300a9b5071434ceb68b25865fc98154b4d913336c74080ef67b34d96a06bc0841b42d413ac3659fc3ae21fc84
-  data.tar.gz: 0d17e8956ef6cc1cc5414c49f36b2c2bbdca9eb575560b8dc8b6458b1fd84ba6d43f24d0f9fcfa31e945bcf94498e25a5a7b17fe93e89a7de1409fb661784665
+  metadata.gz: 22b6778df04698af7b5fb451b2092f98363c4d05f7ee630c8f5f020d9e6467bd8ff218b1cb97b8cbf2354555a20d6d76df658bf86d692062d02dd5a27590df73
+  data.tar.gz: 89b431f8f9390bcefe36933ef681f73814beb1e85d3837413704ae4331e3f727ac3b77fd48b380f0cc45fb497653122c09698ff9cd5b9272c47e2469f16207a9

data/README.md

@@ -1,4 +1,179 @@
-## Installation
+## Getting started
+
+### Installation
   
-  gem install 'vault_of_satoshi'
+```ruby
+gem install 'vault_of_satoshi'
+```
+
+### Some notes about this library
+
+* All responses are returned as `OpenStructs` or `Arrays` of `OpenStructs`, meaning that individual members can be accessed by "dot" syntax or as keys of a `Hash`. For example, `response.date` and `response[:date]` are both valid ways to access the `date` member.
+* The raw API returns `Currency Objects` to represent prices and quantities. This library automatically converts `Currency Objects` into `BigDecimal` in order to retain precision and abstract away the work of converting `Currency Objects` into usable numerical values.
+* For endpoints that require a `Currency Object` as one of the parameters, just use an `Integer`, `Float`, or `BigDecimal`. The library will take care of the rest.
+
+### Setup
+
+```ruby
+api_key = "XXXXXXXXXXXXXXXXXXXXXX"
+api_secret = "XXXXXXXXXXXXXXXXXXXXXX"
+@client = VaultOfSatoshi::API::Client.new(api_key, api_secret)
+```
+
+## Examples
+
+### Currency
+
+```ruby
+currency = @client.info.currency(currency: 'DOGE')
+
+currency.name
+=> "Dogecoin"
+
+currency.virtual
+=> true
+
+currency.tradeable
+=> true
+
+```
+
+### Account
+
+```ruby
+account = @client.info.account
+
+account.created
+=> Sat, 01 Feb 2014 03:06:49 +0000
+
+account.trade_fee.DOGE.to_f
+=> 0.01
+
+account.wallets.DOGE.daily_withdrawal_limit.to_f
+=> 0.0
+```
+
+### Balance
+
+```ruby
+@client.info.balance.DOGE.to_f
+=> 50.0
+```
+
+### Wallet Address
+
+```ruby
+@client.info.wallet_address(currency: 'DOGE').wallet_address
+=> "DD7WjShc937XEmRbGzrCvxjAFAWKwMb9fi"
+```
+
+### Wallet History
+
+```ruby
+@client.info.wallet_history(currency: 'DOGE').map(&:transfer_date)
+=> [Thu, 20 Feb 2014 01:17:35 +0000, Sat, 22 Feb 2014 15:26:09 +0000]
+```
+
+### Ticker
+
+```ruby
+ticker = @client.info.ticker(order_currency: 'DOGE', payment_currency: 'USD')
+
+ticker.date
+=> Sat, 22 Feb 2014 03:57:50 +0000 
+
+ticker.min_price.to_f
+=> 0.00118
+
+ticker.average_price.to_f
+=> 0.00126
+
+ticker.max_price.to_f
+=> 0.00132
+```
+
+### Quote
+
+```ruby
+quote = @client.info.quote(type: 'bid', order_currency: 'DOGE', units: 1000, payment_currency: 'USD', price: 0.0012)
+
+quote.rate.to_f
+=> 0.01
+
+quote.fee.to_f
+=> 0.012
+
+quote.subtotal.to_f
+=> 1.2
+
+quote.total.to_f
+=> 1.212
+```
+
+### Orderbook
+
+```ruby
+orderbook = @client.info.orderbook(order_currency: 'DOGE', payment_currency: 'USD', round: 8, count: 10)
+
+output = "Price      | Quantity  \n"
+output += "-----------------------\n"
+orderbook.asks.each do |ask|
+  output += sprintf("%0.8f", ask.price)
+  output += " | "
+  output += sprintf("%0.1f", ask.quantity).rjust(10)
+  output += "\n"
+end
+
+puts output
+
+Price      | Quantity  
+-----------------------
+0.00131000 |     2618.0
+0.00132000 |    20999.9
+0.00132000 |    20000.0
+0.00132000 |     1324.2
+0.00133000 |    60000.0
+0.00133000 |      100.0
+0.00133000 |    56000.0
+0.00134000 |   380000.0
+0.00135000 |   988320.0
+0.00137000 |   697000.0
+```
+
+### Orders
+
+```ruby
+first_order = @client.info.orders.first
+
+first_order.status
+=> "filled"
+
+first_order.order_id
+=> 540664
+```
+
+### Order Detail
+
+```ruby
+@client.info.order_detail(order_id: 540664).first.units_traded.to_f
+=> 50.0
+```
+
+### Place a Trade
+
+```ruby
+order = @client.trade.place(type: 'bid', order_currency: 'DOGE', units: 5, payment_currency: 'USD', price: 0.0010)
+
+order.order_id
+=> 594853
+```
+
+### Cancel a Trade
+
+```ruby
+@client.trade.cancel(order_id: 594853)
+```
+
+## Donations
 
+If you find this library useful, considering sending a donation! My Dogecoin address is `DD7WjShc937XEmRbGzrCvxjAFAWKwMb9fi`.

data/lib/vault_of_satoshi/api/base.rb

@@ -67,7 +67,7 @@ module VaultOfSatoshi
       end
 
       def parse_currency_object(object)
-        BigDecimal.new(object["value"]).round(object["precision"])
+        BigDecimal.new(object["value"]).truncate(object["precision"])
       end
 
       def parse_boolean(int)

data/lib/vault_of_satoshi/version.rb

@@ -1,3 +1,3 @@
 module VaultOfSatoshi
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/spec/api/info_spec.rb

@@ -24,4 +24,42 @@ describe VaultOfSatoshi::API::Info do
     end
   end
 
+  describe "#balance" do
+    it "should return the expected fields" do
+      data = api_client.info.balance(currency: 'BTC')
+      data.should be_kind_of(BigDecimal)
+    end
+  end
+
+  describe "#wallet_address" do
+    it "should return the expected fields" do
+      data = api_client.info.wallet_address(currency: 'BTC')
+      data.to_h.keys.should include(:wallet_address, :currency)
+    end
+  end
+
+  describe "#ticker" do
+    it "should return the expected fields" do
+      data = api_client.info.ticker(order_currency: 'BTC', payment_currency: 'USD')
+      data.to_h.keys.should include(
+        :date, :opening_price, :closing_price, :min_price, :max_price, 
+        :average_price, :units_traded, :volume_1day, :volume_7day
+      )
+    end
+  end
+
+  describe "#quote" do
+    it "should return the expected fields" do
+      data = api_client.info.quote(type: 'bid', order_currency: 'BTC', units: 1, payment_currency: 'USD', price: 10.0)
+      data.to_h.keys.should include(:rate, :subtotal, :fee, :total)
+    end
+  end
+
+  describe "#orderbook" do
+    it "should return the expected fields" do
+      data = api_client.info.orderbook(order_currency: 'BTC', payment_currency: 'USD')
+      data.to_h.keys.should include(:timestamp, :order_currency, :payment_currency, :bids, :asks)
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault_of_satoshi
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Frank Bonetti