bcoin-client 0.1.0

data/config/containers/bcoin/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "bcoin-server",
+  "version": "1.0.0",
+  "description": "Bcoin installation for development.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Dan Knox <dknox@threedotloft.com> (http://danknox.github.io/)",
+  "license": "MIT",
+  "dependencies": {
+    "bcoin": "^1.0.0-beta.14"
+  }
+}

data/config/containers/ruby/Dockerfile

@@ -0,0 +1,18 @@
+FROM ruby:2.2.5
+MAINTAINER Daniel Knox <dk@bitfs.us>
+ENV REFRESHED_AT 2017-08-09
+
+RUN apt-get update -qq && apt-get install -y build-essential
+
+# cleanup
+RUN rm -rf /var/lib/apt/lists/*
+
+RUN mkdir -p /bcoin-client
+
+ADD . /bcoin-client
+WORKDIR /bcoin-client
+
+RUN gem install bundler
+RUN bundle install
+
+CMD ['bundle', 'exec', 'rspec']

data/docker-compose.yml

@@ -0,0 +1,19 @@
+version: '2'
+services:
+  bcoin-client:
+    build:
+      context: .
+      dockerfile: ./config/containers/ruby/Dockerfile
+    links:
+      - bcoin
+    env_file: .env
+    command: bundle exec rspec
+  bcoin:
+    build: ./config/containers/bcoin
+    environment:
+      PATH: ./node_modules/.bin:$PATH
+    env_file: .env
+    expose:
+      - 8332
+    command:
+      - /bcoin/node_modules/.bin/bcoin --config=/bcoin/bcoin.conf

data/lib/bcoin/client.rb

@@ -0,0 +1,81 @@
+require "bcoin/client/version"
+require "bcoin/client/http_methods"
+require "bcoin/client/base"
+require "bcoin/client/wallet"
+require "bcoin/client/account"
+require "bcoin/client/balance"
+require "bcoin/client/master"
+require "bcoin/client/collection"
+require "bcoin/client/wallets"
+require "bcoin/client/accounts"
+require "httparty"
+
+module Bcoin
+  class Client
+    include HTTParty
+
+    attr_reader :options
+
+    format :json
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def port
+      @options[:port] || 8332
+    end
+
+    def host
+      @options[:host] || "localhost"
+    end
+
+    def username
+      @options[:username]
+    end
+
+    def password
+      @options[:password]
+    end
+
+    def base_uri
+      [host, port].join(':')
+    end
+
+    def basic_auth
+      password.nil? ? nil : {username: username, password: password}
+    end
+
+    def default_options
+      {
+        base_uri: base_uri,
+        basic_auth: basic_auth
+      }
+    end
+
+    def request method, path, options = {}
+      options.merge! default_options
+      self.class.send(method, path, options).parsed_response
+    end
+
+    def get path, options = {}
+      request :get, path, query: options
+    end
+
+    def post path, options = {}
+      request :post, path, body: options.to_json
+    end
+
+    def put path, options = {}
+      request :put, path, body: options.to_json
+    end
+
+    def delete path, options = {}
+      request :delete, path, body: options.to_json
+    end
+
+    def wallets
+      @wallets ||= Wallets.new(self)
+    end
+  end
+end

data/lib/bcoin/client/account.rb

@@ -0,0 +1,21 @@
+module Bcoin
+  class Client
+    class Account < Base
+
+      # Contains an instance of Bcoin::Client::Wallet
+      # which adheres to the HTTP client interface
+      # but builds the URL correctly for the specific
+      # wallet which this account belongs to.
+      attr_reader :client
+
+      def name
+        @attributes[:name]
+      end
+
+      def base_path
+        '/account/' + name.to_s
+      end
+
+    end
+  end
+end

data/lib/bcoin/client/accounts.rb

@@ -0,0 +1,31 @@
+require "bcoin/client/collection"
+require "bcoin/client/account"
+
+module Bcoin
+  class Client
+    class Accounts < Collection
+
+      # Contains an instance of Bcoin::Client::Wallet
+      # which adheres to the HTTP client interface
+      # but builds the URL correctly for the specific
+      # wallet which this account belongs to.
+      attr_reader :client
+
+      def base_path
+        '/account'
+      end
+
+      def refresh!
+        @collection = super.collect { |w|
+          Account.new(client, name: w).refresh!
+        }
+        self
+      end
+
+      def find attr
+        Account.new(client, attr).refresh!
+      end
+
+    end
+  end
+end

data/lib/bcoin/client/balance.rb

@@ -0,0 +1,17 @@
+module Bcoin
+  class Client
+    class Balance < Base
+
+      # Contains an instance of Bcoin::Client::Wallet
+      # which adheres to the HTTP client interface
+      # but builds the URL correctly for the specific
+      # wallet which this account belongs to.
+      attr_reader :client
+
+      def base_path
+        '/balance/'
+      end
+
+    end
+  end
+end

data/lib/bcoin/client/base.rb

@@ -0,0 +1,69 @@
+module Bcoin
+  class Client
+    class Base
+
+      include HttpMethods
+
+      attr_reader :client, :attributes
+
+      def initialize client, attr = {}
+        @client = client
+        self.attributes = attr
+      end
+
+      def inspect
+        printf "#<%s @attributes=%p>", self.class.name, @attributes
+      end
+
+      # Override this in sub class
+      def id
+        'base'
+      end
+
+      # Override this in sub class
+      def base_path
+        '/base'
+      end
+
+      def refresh!
+        self.attributes = get '/'
+        self
+      end
+
+      def wallet_token
+        @attributes[:token] if @attributes
+      end
+
+      def token= _token
+        @attributes[:token] = _token
+      end
+
+      def attributes= attr
+        @attributes = symbolize attr
+      end
+
+      def error= _error
+        @attributes[:error] = _error
+      end
+
+      private
+
+      def symbolize attr
+        symbolized = {}
+        attr.each do |k,v|
+          symbolized[k.to_sym] = v
+        end
+        symbolized
+      end
+
+      def method_missing method, *args
+        if @attributes[method].nil?
+          raise NoMethodError
+        else
+          @attributes[method]
+        end
+      end
+
+    end
+  end
+end

data/lib/bcoin/client/collection.rb

@@ -0,0 +1,47 @@
+require "bcoin/client/http_methods"
+
+module Bcoin
+  class Client
+    class Collection
+
+      include Enumerable
+      include HttpMethods
+
+      attr_reader :client, :collection, :error
+
+      def initialize client, collection = []
+        @client = client
+        @collection = collection
+      end
+
+      def inspect
+        printf "#<%s @collection=%p>", self.class.name, @collection
+      end
+
+      # Redefine in sub class
+      def base_path
+        '/collection'
+      end
+
+      def each &block
+        @collection.each {|w| block.call(w) }
+      end
+
+      # Allow for overriding of the path for situations
+      # like the wallet list retrieval. See the comment
+      # for Wallets#base_path for details.
+      def refresh! path = ''
+        get path + '/'
+      end
+
+      def error?
+        @error ? true : false
+      end
+
+      def error=(_error)
+        @error = _error
+      end
+
+    end
+  end
+end

data/lib/bcoin/client/http_methods.rb

@@ -0,0 +1,53 @@
+module Bcoin
+  class Client
+    module HttpMethods
+
+      # Override this in sub class
+      def base_path
+        '/base'
+      end
+
+      def get path, options = {}
+        options[:token] = wallet_token if wallet_token
+        response = @client.get base_path + path, options
+        set_error_from response
+        response
+      end
+
+      def post path, options = {}
+        options[:token] = wallet_token if wallet_token
+        response = @client.post base_path + path, options
+        set_error_from response
+        response
+      end
+
+      def put path, options = {}
+        options[:token] = wallet_token if wallet_token
+        response = @client.put base_path + path, options
+        set_error_from response
+        response
+      end
+
+      def delete path, options = {}
+        options[:token] = wallet_token if wallet_token
+        response = @client.delete base_path + path, options
+        set_error_from response
+        response
+      end
+
+      # Override this is sub class
+      def wallet_token
+        nil
+      end
+
+      private
+
+      def set_error_from response = {}
+        if response.is_a?(Hash) &&  response['error']
+          self.error = response['error']
+        end
+      end
+
+    end
+  end
+end

data/lib/bcoin/client/master.rb

@@ -0,0 +1,21 @@
+module Bcoin
+  class Client
+    # Contains a copy of the HD Master Key. Depending
+    # on the lock state of the wallet (see Wallet#unlock),
+    # the master key will either be encrypted or in
+    # plain text.
+    class Master < Base
+
+      # Contains an instance of Bcoin::Client::Wallet
+      # which adheres to the HTTP client interface
+      # but builds the URL correctly for the specific
+      # wallet which this account belongs to.
+      attr_reader :client
+
+      def base_path
+        '/master/'
+      end
+
+    end
+  end
+end

data/lib/bcoin/client/version.rb

@@ -0,0 +1,5 @@
+module Bcoin
+  class Client
+    VERSION = "0.1.0"
+  end
+end

data/lib/bcoin/client/wallet.rb

@@ -0,0 +1,109 @@
+require "bcoin/client/accounts"
+require "bcoin/client/balance"
+require "bcoin/client/master"
+
+module Bcoin
+  class Client
+    # The primary bcoin.io Wallet object.
+    class Wallet < Base
+
+      def id
+        @attributes[:id]
+      end
+
+      def base_path
+        '/wallet/' + id.to_s
+      end
+
+      # Retrieve a list of acounts with details.
+      # @return [Bcoin::Client::Accounts]
+      def accounts
+        @accounts ||= Accounts.new(self).refresh!
+      end
+
+      # Access the default account without making another
+      # network request.
+      # @return [Bcoin::Client::Account]
+      def account
+        @account ||= Account.new(self, @attributes[:account])
+      end
+
+      # Retrieve balance information for this wallet.
+      # @return [Bcoin::Client::Balance]
+      def balance
+        @balance ||= Balance.new(self).refresh!
+      end
+
+      # Reset the wallet passphrase. Useful for locking
+      # and unlocking the the master key and wallet coins.
+      # @param [Hash] opts The options for resetting
+      #   the wallet passphrase.
+      # @option opts [String] :old The old password.
+      # @option opts [String] :new The new password.
+      # @return [true, false] True if successful.
+      def passphrase options = {}
+        post '/passphrase', options
+        !error?
+      end
+
+      # Unlock the wallet master key for retrieval of
+      # the wallet mnemonic, and key in plain text for
+      # 'timeout' number of seconds.
+      # @params [Hash] opts The options for unlocking
+      #   the wallet master key.
+      # @option opts [String] :passphrase The wallet passphrase.
+      # @option opts [Integer] :timeout Seconds to unlock the wallet for.
+      # @return [true, false] True if succesful.
+      def unlock options = {}
+        post '/unlock', options
+        !error?
+      end
+
+      # Locks the wallet master key.
+      # @return [true, false] True if succesful.
+      def lock
+        post '/lock'
+        !error?
+      end
+
+      # Retrieves the wallet HD Master Key.
+      # @return [Bcoin::Client::Master] The wallet master key object.
+      def master
+        @master ||= begin
+          response = get '/master'
+          Master.new self, response
+        end
+      end
+
+      # Retrieves a new wallet API token.
+      # @return [Hash] opts
+      # @option opts :token The new wallet API token.
+      def retoken
+        response = post '/retoken'
+
+        if error?
+          false
+        else
+          @attributes[:token] = response['token']
+          true
+        end
+      end
+
+      # Create, sign, and send a new transaction.
+      # @params [Hash] opts Options for the new transaction.
+      # @option opts :rate Rate for the bitcoin network.
+      # @option opts :outputs => [{:value => '', :address => ''}]
+      def send options = {}
+        response = post '/send', options
+        error? ? false : response
+      end
+
+      # Checks for an error returned during a request.
+      # @return [true, false]
+      def error?
+        @attributes[:error] ? true : false
+      end
+
+    end
+  end
+end