bitcoiner 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8b326189cb7c4f1e425fd8dfcd12f97783e037e1abffbe7d5eb4368ffb42224
-  data.tar.gz: dd6fecf9b9c01128978787faeff03ce729bb7251541806ccc96fa5183c36a577
+  metadata.gz: b4a84139151cf83af5599d9d7aad6cfbff0c40e2e183fcc5d39e00115093eb45
+  data.tar.gz: b54b667929c479018b2831f5b6be02316abbbbbe9fd75a1fad83c9b3a12891f0
 SHA512:
-  metadata.gz: 4ee8f5ad16d9267c87bb9cd4bc88332a807682f5243c707729e7ad16e57a275ffd55e2639cec64b04533ebc7f8e3edbb1bb7cb4a1addd7320e8ad18fdedbd49a
-  data.tar.gz: d48a75b3f378c77de02fb8f4c0f95291a5bc6b27750a0d364182312c126ca16a20ddee19b8128c74cdb967407562df8d72198aa1265a5a0f02a400a9488acb3d
+  metadata.gz: 05545c028dfdcca567226137d98b3a99fbf090d356839b053d305ee0b9f73176cc10b432598a0c72cf16a0028592c7b60ae8feefd8d865ec616f547da0698645
+  data.tar.gz: 322bf855b007f5b7c4a94dc3e4b5f51d580a7a94463b06e799d0e8cb7e3d3da354a9b9ab0094b70df8d03d5d40eff194ca0f56c8e6b3b853fd20a8213a30420d

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.2
-before_install: gem install bundler -v 1.16.1
+  - 2.6.0
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0]
+### Added
+- Log requests if logger is set

data/README.md

@@ -88,6 +88,17 @@ tiny_wings.address
 # => "1KV5khnHbbHF2nNQkk7Pe5nPndEj43U27r"
 ```
 
+### Logging
+
+You may log requests (responses aren't logged) by setting a logger:
+
+```
+logger = Logger.new(STDOUT)
+client = Bitcoiner::Client.new('username', 'password', 'http://a.c', {
+  logger: logger,
+})
+```
+
 ## License
 
 Released under the MIT license. See LICENSE.txt for details.

data/bitcoiner.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'addressable'
   spec.add_dependency 'typhoeus', '~> 1.3.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'mocha', '~> 1.1.0'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/bitcoiner/client.rb

@@ -2,15 +2,21 @@
 
 module Bitcoiner
   class Client
-    attr_accessor :endpoint, :username, :password
 
-    def initialize(user, pass, host)
+    DEFAULT_ID = 'jsonrpc'.freeze
+    LOG_PREFIX = "[bitcoiner]".freeze
+
+    attr_accessor :endpoint, :username, :password, :logger
+
+    def initialize(user, pass, host, logger: nil)
       uri = Addressable::URI.heuristic_parse(host)
       self.username = uri.user || user
       self.password = uri.password || pass
       uri.user = uri.password = nil
 
       self.endpoint = uri.to_s
+
+      self.logger = logger
     end
 
     def balance
@@ -24,54 +30,69 @@ module Bitcoiner
 
     def request(method_or_array_of_methods, *args)
       if method_or_array_of_methods.is_a?(Array)
-        post_body = method_or_array_of_methods.map do |m|
-          {
-            'method' => m[0],
-            'params' => m[1],
-            'id' => 'jsonrpc'
-          }
-        end
+        log("#{method_or_array_of_methods}")
+        batch_request(method_or_array_of_methods)
       else
-        post_body = {
-          'method' => method_or_array_of_methods,
-          'params' => args,
-          'id' => 'jsonrpc'
-        }
+        log("#{method_or_array_of_methods}; args: #{args.inspect}")
+        single_request(method_or_array_of_methods, *args)
       end
+    end
+
+    def inspect
+      "#<Bitcoiner::Client #{endpoint.inspect} #{username}:#{password} >"
+    end
+
+    class JSONRPCError < RuntimeError; end
+
+    private
+
+    def post(body)
+      msg = {
+        endpoint: endpoint,
+        username: username,
+        body: body.to_json,
+      }.to_s
+      log(msg)
 
-      response = Typhoeus.post(
+      Typhoeus.post(
         endpoint,
         userpwd: [username, password].join(":"),
-        body: post_body.to_json,
+        body: body.to_json,
       )
+    end
 
-      parsed_response = parse_body(response)
-
-      if parsed_response.is_a?(Hash)
-        raise JSONRPCError, parsed_response['error'] if parsed_response['error']
-        return parsed_response['result']
+    def batch_request(methods_and_args)
+      post_body = methods_and_args.map do |method, args|
+        { 'method' => method, 'params' => args, 'id' => DEFAULT_ID }
       end
-
-      parsed_response
+      response = post(post_body)
+      parse_body(response)
     end
 
-    def inspect
-      "#<Bitcoiner::Client #{endpoint.inspect} #{username}:#{password} >"
-    end
+    def single_request(method, *args)
+      post_body = { 'method' => method, 'params' => args, 'id' => DEFAULT_ID }
+      response = post(post_body)
+      parsed_response = parse_body(response)
 
-    class JSONRPCError < RuntimeError; end
+      raise JSONRPCError, parsed_response['error'] if parsed_response['error']
 
-    private
+      parsed_response['result']
+    end
 
     def parse_body(response)
       if response.success?
         JSON.parse(response.body)
       else
-        error_message = %i[code return_code].map do |attr|
-          "#{attr}: `#{response.send(attr)}`"
-        end.join(', ')
-        raise JSONRPCError, "unsuccessful response; #{error_message}"
+        error_messages = %i[code return_code].each_with_object({}) do |attr, hash|
+          hash[attr] = response.send(attr)
+        end
+        error_messages[:body] = response.body
+        raise JSONRPCError, error_messages.map {|k, v| "#{k}: `#{v}`"}.join("; ")
       end
     end
+
+    def log(msg)
+      self.logger.info("#{LOG_PREFIX} #{msg}") if self.logger
+    end
   end
 end

data/lib/bitcoiner/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bitcoiner
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitcoiner
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Bryce Kerley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2019-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -148,8 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Control the bitcoin nework client over JSON-RPC.