bitshares 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9b32c0ea5eb6d1c9fff1dd36374f01b15122882
+  data.tar.gz: da5e2e39c271e30232052c9b193524637990bb01
+SHA512:
+  metadata.gz: e969d690cba21ce4d2cdbebc0e935c5a7189c9ffeb067eaac8b025a211b17ceeff2c1f9d636aac4ebab2a988d0caac5573e952123ea2f02ca5a81bec96837638
+  data.tar.gz: 420309ee77866f3ef0be97dedb6ed4546f6eac8c93aa5d58f04d727620cf5fcf3428ae7ab83dbfc538969618738be913c6eedc2575cd5e181ee2b1a626435550

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bruce Steedman
+
+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,155 @@
+# Bitshares Ruby Gem
+
+This Gem provides a Ruby API for the BitShares command line client by exposing the RPC commands of the [Bitshares client v0.x](https://github.com/bitshares/bitshares) as methods of it's Client class.
+
+The binary client; "bitshares_client" must be installed, configured and running. The Gem detects the port the HTTP JSON RPC server is running on and expects the RPC endpoint to be `localhost` for security reasons - see [Configuration file settings](http://wiki.bitshares.org/index.php/BitShares/API).
+
+## Requirements
+
+_Important:_ The interface uses the command line binary, not the GUI app.
+Tested with v0.9.2 client on Mac OS X (10.9.5) and Ubuntu 14.04. Should work on any *NIX platform - sorry not Windows.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bitshares-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bitshares-ruby
+
+## Authentication
+
+RPC server login credentials (registered account name and password) must be stored in the following environment variables:-
+
+  `$BITSHARES_ACCOUNT`
+
+  `$BITSHARES_PASSWORD`
+
+## Configuration
+
+The Gem allows multiple wallet names and passwords to be stored so that actions requiring these data may be automated.
+To use this functionality - i.e. with the Wallet class (see below) wallet names and passwords must be configured in either of the following ways:
+
+**Via a hash**
+```Ruby
+Bitshares.configure(:wallet => {:name => 'wallet1', :password => 'password1'})
+Bitshares.configure(:wallet => {:name => 'wallet2', :password => 'password2'})
+...
+```
+
+**From a Yaml configuration file**
+```Ruby
+Bitshares.configure_with(<path to Yaml file>) # 'wallets' and 'passwords' keys and array values must be used, as above
+```
+
+```Ruby
+Bitshares.config # returns the configuration hash
+```
+
+## Usage
+
+### Quick start
+
+```ruby
+require 'bitshares'
+
+client = Bitshares::Client.init # The object BitShares RPC client calls are routed to.
+```
+Any valid client command can then be issued via a method call with relevant parameters - e.g.
+
+```ruby
+client.get_info
+client.wallet_open 'default'
+client.blockchain_list_delegates
+client_wallet_market_submit_bid(account, amount, quote, price, base)
+...
+```
+
+Data is returned as a hash
+
+### Detailed usage
+
+**Blockchain**
+
+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`
+```
+
+**Wallet**
+
+```Ruby
+wallet = Bitshares::Wallet.new 'wallet1' # opens a wallet available on this client.
+```
+Note that the following command opens the named wallet, but does not return an instance of Wallet class - use Wallet.new
+```Ruby
+wallet.open 'wallet1'
+```
+
+Thereafter 'wallet_' commands may be issued like this:
+```Ruby
+wallet.get_info # gets info on this wallet, equivalent to client.wallet_get_info
+wallet.transfer(amount, asset, from, recipient) # equivalent to - you get the picture..
+```
+A wallet is unlocked and closed in a similar fashion:
+```Ruby
+wallet.unlock
+wallet.close
+```
+
+Predicates are provided for convenience:
+```Ruby
+wallet.open?
+wallet.unlocked?
+```
+
+**Account**
+
+Once you have a wallet instance you can do this:
+```Ruby
+account = wallet.account 'account_name'
+```
+Thereafter 'wallet_account_' commands may be issued like this:
+```Ruby
+account.balance
+account.register(account_name, pay_from)
+```
+
+**Market**
+
+The market class represents the trading (order book and history) for a given an asset-pair - e.g. CNY/BTS. It is instantiated like this:
+```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:
+```Ruby
+market.list_bids
+market.order_history
+```
+
+## Testing and specification
+
+`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'
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MatzFan/bitshares-ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'bitshares-ruby'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bitshares-ruby.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitshares/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'bitshares'
+  s.version       = Bitshares::VERSION
+  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.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 1.10'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/bitshares-ruby.rb

@@ -0,0 +1,41 @@
+require 'bitshares/version'
+
+require 'json'
+require 'uri'
+require 'net/http'
+require 'yaml'
+
+require 'bitshares/client'
+require 'bitshares/blockchain'
+require 'bitshares/wallet'
+require 'bitshares/account'
+require 'bitshares/market'
+
+# stackoverflow.com/questions/6233124/where-to-place-access-config-file-in-gem
+module Bitshares
+  @config = {:wallets => {nil => nil}} # name/password key/value pairs
+
+  @valid_keys = @config.keys
+
+  def self.configure(opts = {})
+    opts.each {|k,v| @config[k.to_sym] = v if @valid_keys.include? k.to_sym}
+  end
+
+  def self.configure_with(path_to_yaml_file)
+    begin
+      config = YAML::load(IO.read(path_to_yaml_file))
+    rescue Errno::ENOENT
+      puts "YAML configuration file couldn\'t be found. Using defaults"
+      return
+    rescue Psych::SyntaxError
+      puts 'YAML configuration file contains invalid syntax. Using defaults'
+      return
+    end
+
+    configure(config)
+  end
+
+  def self.config
+    @config
+  end
+end

data/lib/bitshares/account.rb

@@ -0,0 +1,18 @@
+module Bitshares
+
+  class Account
+
+    attr_reader :wallet, :name
+
+    def initialize(wallet, name)
+      @wallet = wallet
+      @name = name
+    end
+
+    def method_missing(name, *args)
+      Bitshares::Client::rpc.request('wallet_account_' + name.to_s, args)
+    end
+
+  end
+
+end

data/lib/bitshares/blockchain.rb

@@ -0,0 +1,11 @@
+module Bitshares
+
+  class Blockchain
+
+    def self.method_missing(name, *args)
+      Bitshares::Client::rpc.request('blockchain_' + name.to_s, args)
+    end
+
+  end
+
+end

data/lib/bitshares/client.rb

@@ -0,0 +1,65 @@
+module Bitshares
+
+  class Client
+
+    def self.init
+      @user = ENV['BITSHARES_ACCOUNT']
+      @password = ENV['BITSHARES_PASSWORD']
+      @@rpc_instance = Bitshares::Client::Rpc.new(@user, @password)
+      return self
+    end
+
+    def self.rpc
+      @@rpc_instance
+    end
+
+    def self.method_missing(method, *args)
+      @@rpc_instance.request(method, args)
+    end
+
+    class Rpc
+
+      class Err < RuntimeError; end
+
+      def initialize(user, password)
+        bitshares_running?
+        @uri = URI("http://localhost:#{rpc_http_port}/rpc")
+        @req = Net::HTTP::Post.new(@uri)
+        @req.content_type = 'application/json'
+        @req.basic_auth user, password
+      end
+
+      def request(m, args = [])
+        resp = nil
+        Net::HTTP.start(@uri.hostname, @uri.port) do |http|
+          @req.body = { method: m, params: args, jsonrpc: '2.0', id: 0 }.to_json
+          resp = http.request(@req)
+        end
+        raise Err, 'Bad credentials' if resp.class == Net::HTTPUnauthorized
+        result = JSON.parse(resp.body)
+        e = result['error']
+        raise Err, JSON.pretty_generate(e), "#{m} #{args.join(' ') if args}" if e
+        return result['result']
+      end
+
+      private
+
+      def bitshares_running?
+        raise Err, 'Server not running!' unless rpc_ports.count == 2
+      end
+
+      def rpc_http_port
+        rpc_ports.each do |port| # only http RPC port raises a non-empty response
+          return port unless `curl -s -I -L http://localhost:#{port}`.empty?
+        end
+      end
+
+      def rpc_ports # returns bitshares HTTP JSON RPC and JSON RPC server ports
+        `lsof -iTCP@localhost | grep bitshares`.scan(/:(\d+) \(LISTEN\)/).flatten
+      end
+
+    end
+
+  end
+
+end

data/lib/bitshares/market.rb

@@ -0,0 +1,102 @@
+module Bitshares
+
+  class Market
+
+    class AssetError < RuntimeError; end
+
+    CHAIN = Bitshares::Blockchain
+    SELL_ORDER_TYPES = %w(ask_order cover_order)
+    BUY_ORDER_TYPES = %w(bid_order)
+
+    attr_reader :quote, :base
+
+    def initialize(quote_symbol, base_symbol)
+      @quote_hash = get_asset quote_symbol.upcase
+      @base_hash =  get_asset base_symbol.upcase
+      @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
+      return -1 if order_hist.empty?
+      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
+    end
+
+    def highest_bid
+      return if bids.empty?
+      price bids.first
+    end
+
+    private
+
+    def get_asset(s)
+      CHAIN.get_asset(s) || (raise AssetError, "No such asset: #{s}")
+    end
+
+    def market_status
+      CHAIN.market_status(@quote, @base)
+    end
+
+    def order_book
+      CHAIN.market_order_book(@quote, @base)
+    end
+
+    def order_hist
+      CHAIN.market_order_history(@quote, @base)
+    end
+
+    def multiplier
+      @base_hash['precision'].to_f / @quote_hash['precision']
+    end
+
+    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
+    end
+
+    def buy_orders
+      bids = @order_book.first
+      check_new_order_type(bids, BUY_ORDER_TYPES)
+    end
+
+    def bids
+      buy_orders.select { |p| p['type'] == 'bid_order' }
+    end
+
+    def sell_orders # includes 'ask_type' and 'cover_type'
+      asks = @order_book.last
+      check_new_order_type(asks, SELL_ORDER_TYPES)
+    end
+
+    def asks
+      sell_orders.select { |p| p['type'] == 'ask_order' }
+    end
+
+    def covers
+      sell_orders.select { |p| p['type'] == 'cover_order' }
+    end
+
+    def price(order) # CARE: preserve float precision with * NOT /
+      order['market_index']['order_price']['ratio'].to_f * @multiplier
+    end
+
+  end
+
+end

data/lib/bitshares/version.rb

@@ -0,0 +1,3 @@
+module Bitshares
+  VERSION = '0.1.0.pre'
+end

data/lib/bitshares/wallet.rb

@@ -0,0 +1,54 @@
+module Bitshares
+
+  class Wallet
+
+    attr_reader :name, :account
+
+    def initialize(name)
+      @name = name
+      @account = nil
+      @password = Bitshares.config[:wallets][@name.to_sym]
+    end
+
+    def account(name)
+      @account = Bitshares::Account.new(self, name)
+    end
+
+    def open
+      Bitshares::Client::rpc.request('wallet_open', [@name])
+    end
+
+    def lock
+      open # must be opened first
+      Bitshares::Client::rpc.request 'wallet_lock'
+    end
+
+    def unlock(timeout = 1776)
+      open # must be opened first
+      Bitshares::Client::rpc.request('wallet_unlock', [timeout, @password])
+    end
+
+    def open?
+      self.get_info['open']
+    end
+
+    def closed?
+      !open?
+    end
+
+    def unlocked?
+      open
+      get_info['unlocked']
+    end
+
+    def locked?
+      !unlocked?
+    end
+
+    def method_missing(name, *args)
+      Bitshares::Client::rpc.request('wallet_' + name.to_s, args)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: bitshares
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Bruce Steedman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Exposes the BitShares client commands via RPC interface
+email:
+- bruce.steedman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bitshares-ruby.gemspec
+- lib/bitshares-ruby.rb
+- lib/bitshares/account.rb
+- lib/bitshares/blockchain.rb
+- lib/bitshares/client.rb
+- lib/bitshares/market.rb
+- lib/bitshares/version.rb
+- lib/bitshares/wallet.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby API for BitShares client
+test_files: []