bitcoind_rpc 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f74740329efd56a839d8fd49beb9b8afd03ac12c
-  data.tar.gz: 1193a537f6b3486f5acb53fcf3385866932ba1c9
+  metadata.gz: 79c3c0305faaac12a984279bb387c5dbea898dd5
+  data.tar.gz: 6551d3485a5fd61b3e17f796d7a0d5622f6fc527
 SHA512:
-  metadata.gz: 3706284e82201f575dc003ce85eede6176ebcda1c4709f67be722d33e4fb4e846522be3686438deb232b571cd71b5024c54ffbb9a03e06e677cb7b6e9b167650
-  data.tar.gz: f52e87dce9121b3e1be4e277f042b41876aa8c630de92117bdb79f29ef9dbfd1e422718e71c42cdb1ae551ea8cb0eec2e9ca0766863ab6ce5831385b78180b25
+  metadata.gz: a48811ef87ee14964e6164fd4bb13bcf17a4896b4cee6c3b4e4d977ff5b9b2e5e3fea6e709d951509d28304e38b4526312df720f8852a30af88687f82cad2272
+  data.tar.gz: 65bda6c214c0e9e3239bd821be130df68761caa9d557d1a1b4a4c4f272ecedef5ea3054db7275cc151334b0d9bab2780e20cbbe3a3ac2fef92937f586d14e60e

data/README.md

@@ -1,6 +1,12 @@
-# BitcoindRPC
+# Bitcoind RPC
 
-A Ruby client for the bitcoind JSON-RPC.
+A Ruby client for the *bitcoind* ([Bitcoin Core](https://github.com/bitcoin/bitcoin) compatible) JSON-RPC.
+
+Features:
+
+* Parses floats as BigDecimal
+* Lists methods supported by the connected bitcoind
+* Allows access to RPC methods as plain Ruby methods of Connection object
 
 ## Installation
 
@@ -20,7 +26,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+
+require 'bitcoind_rpc'
+
+bitcoind = BitcoindRPC::Connection.new(uri: 'http://{username}:{password}@{host}:{port}')
+
+bitcoind.supported_methods # => [ :getbestblockhash, :getblock, ... ]
+bitcoind.getbalance # => #<BigDecimal:...>
+bitcoind.blablabla # => NoMethodError
+
+bitcoind.getblock "3d587773d2cbaf64f208f165f5f7717d7324350612d189063b4d1d2f14711380" # => { :hash => "3d58..." ...}
+
+```
 
 
 ## Contributing

data/bitcoind_rpc.gemspec

@@ -27,6 +27,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'oj', '~> 2.15'
+
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/lib/bitcoind_rpc.rb

@@ -1,5 +1,28 @@
-require 'bitcoind_rpc/version'
+require 'logger'
+require_relative 'bitcoind_rpc/version'
+require_relative 'bitcoind_rpc/connection'
 
 module BitcoindRPC
-  # Your code goes here...
-end
+  DEFAULT_OPTIONS = {
+    logger: Logger.new(STDOUT).tap { |l| l.level = ::Logger::WARN }
+  }.freeze
+
+  def self.configure(opts = {})
+    opts = DEFAULT_OPTIONS.dup.merge(opts.dup)
+    @connection = BitcoindRPC::Connection.new(opts)
+    @logger     = opts[:logger] if opts[:logger]
+    @connection
+  end
+
+  def self.connection
+    @connection
+  end
+
+  def self.logger
+    @logger ||= DEFAULT_OPTIONS[:logger]
+  end
+
+  def self.logger=(new_logger)
+    @logger = new_logger
+  end
+end # module BitcoindRPC

data/lib/bitcoind_rpc/connection.rb

@@ -0,0 +1,85 @@
+require 'oj'
+require 'net/http'
+
+module BitcoindRPC
+  class Connection
+    attr_reader :options, :uri
+
+    DEFAULT_OPTIONS = {
+      host: 'localhost',
+      port: 18332 # Default for testnet: 18332, for mainnet: 8332
+    }.freeze
+
+    CONTENT_TYPE = 'application/json'.freeze
+
+    # Creates a new connection to a bitcoind
+    #
+    # @param [Hash] opts Connection parameters
+    # @option opts [String] :host
+    # @option opts [String] :port
+    # @option opts [String] :username
+    # @option opts [String] :password
+    # @option opts [String,URI] :uri Specify a complete URI instead of separate host, port etc
+    #
+    def initialize(opts)
+      @options = DEFAULT_OPTIONS.dup.merge(opts.dup)
+      @uri = @options[:uri] ? URI(@options[:uri]) : URI(uri_to_s)
+    end
+
+    def respond_to_missing?(name, _include_all = false)
+      supported_methods.include?(name.to_sym) || super
+    end
+
+    def method_missing(name, *args)
+      return request(name, *args) if supported_methods.include?(name.to_sym)
+      super
+    end
+
+    def request(name, *args)
+      BitcoindRPC.logger.debug "> #{name}: #{args.join(',')}"
+      response = request_http_post(name, args)
+      BitcoindRPC.logger.debug "< #{response.code} #{response.message}"
+      raise Error, response.message unless (200...300).cover?(response.code.to_i)
+      begin
+        response = Oj.load(response.body, symbol_keys: true, bigdecimal_load: true)
+      rescue StandardError => e
+        BitcoindRPC.logger.warn "Failed to parse JSON response: #{e}"
+        raise
+      end
+      raise Error, response[:error] if response[:error]
+      response[:result]
+    end
+
+    # Makes a request to a bitcoind instance once and returns the list of supported RPC methods
+    #
+    def supported_methods
+      return @supported_methods if @supported_methods
+      help_response = request(:help)
+      mm = help_response.split("\n").select { |l| l =~ /^\w+(\s|$)/ }
+      @supported_methods = mm.map { |l| l.split(' ').first }.map(&:to_sym)
+    end
+
+    private
+
+    def uri_to_s
+      "http://#{options[:username]}:#{options[:password]}@#{options[:host]}:#{options[:port]}"
+    end
+
+    def request_http_post(name, params)
+      username = uri.user
+      password = uri.password
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.basic_auth(username, password)
+      request.body = request_body(name, params)
+      request['Content-Type'] = CONTENT_TYPE
+      http.request(request)
+    end
+
+    def request_body(name, params)
+      Oj.dump({ method: name, params: params, id: 'jsonrpc' }, mode: :compat)
+    end
+
+    class Error < RuntimeError; end
+  end # class Connection
+end # module BitcoindRPC

data/lib/bitcoind_rpc/version.rb

@@ -1,3 +1,3 @@
 module BitcoindRPC
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitcoind_rpc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alex Kukushkin
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -85,6 +99,7 @@ files:
 - bin/setup
 - bitcoind_rpc.gemspec
 - lib/bitcoind_rpc.rb
+- lib/bitcoind_rpc/connection.rb
 - lib/bitcoind_rpc/version.rb
 homepage: https://github.com/kukushkin/bitcoind_rpc
 licenses: