bitshares 0.1.3.pre → 0.1.4.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5abeb08a0df5d7e8dc67c611ddb45d0032e9277
-  data.tar.gz: 438ac564de494dc95c61f97ab45ae04b9a6dd08c
+  metadata.gz: d78dd854953b6dd4587d6325f78ed684d00cc73a
+  data.tar.gz: 398253f2043e57805839cc50f5a6c1c7be05dc22
 SHA512:
-  metadata.gz: 036523ba906162a2a4c19ee4e22bbcdd285bebfcea283238330d07172d03f67ca55bcc1bed43eeed231d4bd700b8ea926eddea9bdcf840652eea47a8a94623f0
-  data.tar.gz: 68a70ade2b49f1c6318062d1a1875535bf8bb9f0e14dcc4ce66ee65ab10db5bec2d376ca886ea0ed7f15317a700e4d392dac643a97ab408ad31ef03a278fb922
+  metadata.gz: f847a6172160020215ebc108a63b6cd7b1ab9d0b48e07535996a328f17ec09cfc39ce062ec248c341d449ec2153a7a6cb8062208d9fcc658b0b752228c43d8d6
+  data.tar.gz: 16d6cdebae1a700b0c9dc6d7708d550d7a1c9611fae623ed395ed3010d9610e4ad37b5b9b4483f10913a8052251cab24a7c682ebcd7abc169d7639a6e6edd244

data/.gitignore

@@ -1,6 +1,9 @@
 /.bundle/
 /.yardoc
 /Gemfile.lock
+/Guardfile
+/bin/guard
+/bin/_guard-core
 /_yardoc/
 /coverage/
 /doc/

data/README.md

@@ -47,7 +47,7 @@ Bitshares.configure(:wallet => {:name => 'wallet2', :password => 'password2'})
 
 **From a Yaml configuration file**
 ```Ruby
-Bitshares.configure_with(<path to Yaml file>)
+Bitshares.configure_with 'path-to-Yaml-file'
 ```
 
 ```Ruby
@@ -82,7 +82,7 @@ Data is returned as a hash
 The blockchain is implemented as a class purely for convenience when calling 'blockchain_' methods:
 ```Ruby
 chain = Bitshares::Blockchain
-count = chain.get_block_count # equivalent to `client.blockchain_get_block_count`
+count = chain.get_block_count # equivalent to client.blockchain_get_block_count
 ```
 
 **Wallet**
@@ -114,14 +114,19 @@ wallet.unlocked?
 
 **Account**
 
-Once you have a wallet instance you can do this:
+Once you have a wallet instance you can do the following, which references a particular wallet account:
 ```Ruby
 account = wallet.account 'account_name'
 ```
-Thereafter 'wallet_account_' commands may be issued like this:
+Thereafter all 'wallet_account_' client commands may be issued without specifying the account_name parameter:
 ```Ruby
-account.balance
-account.register(account_name, pay_from)
+account.balance # balance for a particular account
+account.order_list # optional [limit] param
+account_register(pay_from_account [, optional params]) # this command takes up to 3 optional params
+```
+'wallet_account_' client commands taking an *optional* account_name parameter list all data for all of a wallet's accounts. If this is required, the relevant Wallet method should be used - e.g:
+```Ruby
+wallet.account_balance # lists the balances for all accounts for this wallet (c.c. above)
 ```
 
 **Market**
@@ -130,23 +135,40 @@ The market class represents the trading (order book and history) for a given an
 ```Ruby
 market = Bitshares::Market.new('CNY', 'BTS')
 ```
-Any 'blockchain_market_' client method may then be used without specifying the quote and base assets again e.g:
+The following 'blockchain_market_' client methods may then be used without specifying the quote and base assets again, but with any other optional params the client accepts:
 ```Ruby
+market.list_asks # equivalent to blockchain_market_list_asks(quote, base) [limit]
 market.list_bids
+market.list_covers
+market.order_book
 market.order_history
+market.price_history # required params are: <start time> <duration> optional: [granularity]
+
+market.list_shorts # requires no params and ignores the base asset
+get_asset_collateral # requires no params and returns the collateral for the quote asset (ignores the base asset)
 ```
 
-## Testing and specification
+Additionally, the following methods are available:
+```Ruby
+market.lowest_ask
+market.highest_bid
+market.mid_price # mean of the above
+market.last_fill # price of the last filled order
+```
+
+## Specification & tests
+
+For the full specification please clone this repo and run:
 
 `rake spec`
 
 _Important:_ There is currently no sandbox, so the test suite runs on your live client. If this concerns you - and it should :scream: - feel free to browse the code. In particular, the following client 'fixtures' are required for the full test suite to run and pass:
 
-An empty wallet 'test1', with password 'password1'
+An empty wallet 'test1', with password 'password1' and an account called 'account-test' (please don't register this account!)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/MatzFan/bitshares-ruby.
+Bug reports and pull requests (and feature requests) are welcome on GitHub at https://github.com/MatzFan/bitshares-ruby.
 
 
 ## License

data/bitshares-ruby.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors       = ['Bruce Steedman']
   s.email         = ['bruce.steedman@gmail.com']
 
-  s.summary       = %q{Ruby API for BitShares client}
-  s.description   = %q{Exposes the BitShares client commands via RPC interface}
+  s.summary       = %q{Ruby API for BitShares CLI client}
+  s.description   = %q{Ruby API for BitShares CLI client}
   s.license       = "MIT"
 
   s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
@@ -21,4 +21,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler', '~> 1.10'
   s.add_development_dependency 'rake', '~> 10.0'
   s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'guard-rspec', '~> 4.0'
+  s.add_development_dependency 'growl', '~> 1.0'
 end

data/lib/bitshares/account.rb

@@ -2,6 +2,8 @@ module Bitshares
 
   class Account
 
+    CLIENT = Bitshares::Client
+
     attr_reader :wallet, :name
 
     def initialize(wallet, name)
@@ -9,8 +11,8 @@ module Bitshares
       @name = name
     end
 
-    def method_missing(name, *args)
-      Bitshares::Client::rpc.request('wallet_account_' + name.to_s, args)
+    def method_missing(m, *args)
+      CLIENT::rpc.request('wallet_account_' + m.to_s, [name] + args)
     end
 
   end

data/lib/bitshares/client.rb

@@ -13,8 +13,12 @@ module Bitshares
       @@rpc_instance
     end
 
-    def self.method_missing(method, *args)
-      @@rpc_instance.request(method, args)
+    def self.synced?
+      blockchain_get_block_count >= self.get_info['blockchain_head_block_num']
+    end
+
+    def self.method_missing(m, *args)
+      @@rpc_instance.request(m, args)
     end
 
     class Rpc

data/lib/bitshares/market.rb

@@ -5,22 +5,15 @@ module Bitshares
     class AssetError < RuntimeError; end
 
     CHAIN = Bitshares::Blockchain
-    SELL_ORDER_TYPES = %w(ask_order cover_order)
-    BUY_ORDER_TYPES = %w(bid_order)
+    CLIENT = Bitshares::Client
 
     attr_reader :quote, :base
 
-    def initialize(quote_symbol, base_symbol)
-      @quote_hash = get_asset quote_symbol.upcase
-      @base_hash =  get_asset base_symbol.upcase
+    def initialize(quote, base)
+      [quote, base].each &:upcase!
+      @quote_hash, @base_hash = asset(quote), asset(base)
+      @quote, @base = @quote_hash['symbol'], @base_hash['symbol']
       @multiplier = multiplier
-      @quote = @quote_hash['symbol']
-      @base = @base_hash['symbol']
-      @order_book = order_book
-    end
-
-    def center_price
-      market_status['center_price']['ratio'].to_f
     end
 
     def last_fill
@@ -28,11 +21,6 @@ module Bitshares
       order_hist.first['bid_index']['order_price']['ratio'].to_f * multiplier
     end
 
-    def mid_price
-      return nil if highest_bid.nil? || lowest_ask.nil?
-      (highest_bid + lowest_ask) / 2
-    end
-
     def lowest_ask
       return if asks.empty?
       price asks.first
@@ -43,54 +31,43 @@ module Bitshares
       price bids.first
     end
 
-    private
-
-    def get_asset(s)
-      CHAIN.get_asset(s) || (raise AssetError, "No such asset: #{s}")
+    def mid_price
+      return nil if highest_bid.nil? || lowest_ask.nil?
+      (highest_bid + lowest_ask) / 2
     end
 
-    def market_status
-      CHAIN.market_status(@quote, @base)
+    def list_shorts(limit = nil) # uses quote only, not base
+      CLIENT::rpc.request('blockchain_market_list_shorts', [quote] + [limit])
     end
 
-    def order_book
-      CHAIN.market_order_book(@quote, @base)
+    def get_asset_collateral # uses quote only, not base
+      CLIENT::rpc.request('blockchain_market_get_asset_collateral', [quote])
     end
 
-    def order_hist
-      CHAIN.market_order_history(@quote, @base)
+    def method_missing(m, *args)
+      CLIENT::rpc.request('blockchain_market_' + m.to_s, [quote, base] + args)
     end
 
-    def multiplier
-      @base_hash['precision'].to_f / @quote_hash['precision']
-    end
+    private
 
-    def check_new_order_type(order_list, order_types)
-      new_ = order_list.reject { |p| order_types.any? { |t| p['type'] == t } }
-      raise AssetError, "New order type: #{new_.first}" unless new_.empty?
-      order_list
+    def asset(symbol) # returns hash
+      CHAIN.get_asset(symbol) || (raise AssetError, "Invalid asset: #{symbol}")
     end
 
-    def buy_orders
-      bids = @order_book.first
-      check_new_order_type(bids, BUY_ORDER_TYPES)
+    def order_hist
+      self.order_history
     end
 
-    def bids
-      buy_orders.select { |p| p['type'] == 'bid_order' }
+    def multiplier
+      @base_hash['precision'].to_f / @quote_hash['precision']
     end
 
-    def sell_orders # includes 'ask_type' and 'cover_type'
-      asks = @order_book.last
-      check_new_order_type(asks, SELL_ORDER_TYPES)
+    def bids
+      self.list_bids
     end
 
     def asks
-      sell_orders.select { |p| p['type'] == 'ask_order' }
-    end
-
-    def covers
-      sell_orders.select { |p| p['type'] == 'cover_order' }
+      self.list_asks
     end
 
     def price(order) # CARE: preserve float precision with * NOT /

data/lib/bitshares/version.rb

@@ -1,3 +1,3 @@
 module Bitshares
-  VERSION = '0.1.3.pre'
+  VERSION = '0.1.4.pre'
 end

data/lib/bitshares/wallet.rb

@@ -45,8 +45,8 @@ module Bitshares
       !unlocked?
     end
 
-    def method_missing(name, *args)
-      Bitshares::Client::rpc.request('wallet_' + name.to_s, args)
+    def method_missing(m, *args)
+      Bitshares::Client::rpc.request('wallet_' + m.to_s, args)
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitshares
 version: !ruby/object:Gem::Version
-  version: 0.1.3.pre
+  version: 0.1.4.pre
 platform: ruby
 authors:
 - Bruce Steedman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-11 00:00:00.000000000 Z
+date: 2015-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Exposes the BitShares client commands via RPC interface
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby API for BitShares CLI client
 email:
 - bruce.steedman@gmail.com
 executables: []
@@ -99,5 +127,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Ruby API for BitShares client
+summary: Ruby API for BitShares CLI client
 test_files: []