nano_rpc 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d10073bf6ebd0cca384ce4de513f53f7356bbf289731f8dcdf322496a6089e68
-  data.tar.gz: '059b36ad240027dc29f655a9bdb07649b79e7279712472b508baeb09a31e5df1'
+  metadata.gz: a9978232fd9a93d80e7788e5199d61961c6e79984c38402c75a71582ed61eeef
+  data.tar.gz: 65239db16d0090666afe5cf1da64f9ef6fe2372e66a9ff9dae25c9321abaa99b
 SHA512:
-  metadata.gz: 2de3f22e5b894b2e421fe93f5b424b646807b8ec9b1e3fda89108eaaa589a48c1ee46eecaf00f615d593a9d0d48f9fe234118773d686e03c21b732bceae44b3b
-  data.tar.gz: cd8780df5f4ce82724aa42c12cc2183c9440e30d3961f5e9a25abe48895c124097f26e0d86b6b7ac5f98dd73357325045a857ee9e734cd2b7a1f46d58029ac21
+  metadata.gz: b6e9d40af5b66f3717e8216cfa339aa3341e71079a7c16c2a0e299b659ef201e52ac4f85acc1d6f5e685ea5fceccf393d0da774c19f7d375707958c09e255a88
+  data.tar.gz: 292204a915746ed0cd49435995eb3e47bd771cfd5de2cd53f7eb8e5992b17cf52354b5a3ad122e423c3f9c27874b32e2094f9f4376e1ffe7bd8fe00e02b33330

data/README.md

@@ -1,6 +1,6 @@
 ![Ruby Nano RPC Logo](https://i.imgur.com/ihmmYcp.png)
 
-Nano RPC is a Ruby wrapper for making Remote Procedure Calls against Nano digitial currency nodes. Arbitrary RPC access is provided along with proxy objects that expose helper methods ([Wiki](https://github.com/jcraigk/ruby_nano_rpc/wiki/Proxy-Object-Reference)).
+Nano RPC is a Ruby wrapper for making Remote Procedure Calls against Nano digitial currency nodes. Arbitrary RPC access is provided along with proxy objects that expose helper methods ([Wiki](https://github.com/jcraigk/ruby_nano_rpc/wiki)).
 
 To run a Nano node locally, see [Nano Docker Docs](https://github.com/clemahieu/raiblocks/wiki/Docker-node).
 
@@ -40,7 +40,19 @@ client = Nano.client
 client = Nano::Client.new(host: 'mynanonode', port: 1234)
 ```
 
-Then make a `call`, passing the action and data:
+If you're using [Nanode](https://www.nanode.co/) or similar service that requires `Authorization` key in HTTP header, you can specify it using `auth`.
+
+```ruby
+client = Nano::Client.new(auth: 'someauthkey')
+```
+
+You can also specify custom headers as a hash. These will be sent with every RPC request.
+
+```ruby
+client = Nano::Client.new(headers: { 'Authorization' => 'someauthkey' })
+```
+
+Once the client is created, make a `call`, passing the action and data:
 
 ```ruby
   client.call(:account_balance, account: 'xrb_someaddress1234')

data/lib/nano_rpc/client.rb

@@ -10,11 +10,13 @@ module Nano
   class Client
     include Nano::ApplicationHelper
 
-    attr_accessor :host, :port
+    attr_reader :host, :port, :auth, :headers
 
-    def initialize(host: 'localhost', port: 7076)
+    def initialize(host: 'localhost', port: 7076, auth: nil, headers: nil)
       @host = host
       @port = port
+      @auth = auth
+      @headers = headers
     end
 
     # Condense host/port on object inspection
@@ -53,14 +55,21 @@ module Nano
       response = rest_client_post(url, params)
       ensure_status_success!(response)
 
-      data = Nano::Response.new(JSON[response.body])
+      data = Nano::Response.new(JSON[response&.body])
       ensure_valid_response!(data)
 
       data
     end
 
+    def request_headers
+      h = headers || {}
+      h['Content-Type'] = 'json'
+      h['Authorization'] = auth unless auth.nil?
+      h
+    end
+
     def rest_client_post(url, params)
-      RestClient.post(url, params.to_json)
+      RestClient.post(url, params, request_headers)
     rescue Errno::ECONNREFUSED
       raise Nano::NodeConnectionFailure,
             "Node connection failure at #{url}"
@@ -70,13 +79,17 @@ module Nano
     end
 
     def url
-      "http://#{host}:#{port}"
+      if host.start_with?('http://', 'https://')
+        "#{host}:#{port}"
+      else
+        "http://#{host}:#{port}"
+      end
     end
 
     def ensure_status_success!(response)
-      return if response.code == 200
+      return if response&.code == 200
       raise Nano::BadRequest,
-            "Error response from node: #{JSON[response.body]}"
+            "Error response from node: #{JSON[response&.body]}"
     end
 
     def ensure_valid_response!(data)

data/lib/nano_rpc/helpers/wallet_helper.rb

@@ -60,6 +60,7 @@ module Nano::WalletHelper
   def enter_password(password:)
     password_enter(password: password).valid == 1
   end
+  alias unlock enter_password
 
   def export
     Nano::Response.new(JSON[wallet_export.json])
@@ -137,11 +138,12 @@ module Nano::WalletHelper
   end
   alias set_representative representative_set
 
-  def send_nano(from:, to:, amount:, work: nil)
+  def send_nano(from:, to:, amount:, id: nil, work: nil)
     send_currency(
       source: from,
       destination: to,
       amount: amount,
+      id: id,
       work: work
     ).block
   end

data/lib/nano_rpc/proxies/wallet.rb

@@ -33,7 +33,9 @@ class Nano::Wallet
   proxy_method :payment_init
   proxy_method :payment_end, required: %i[account]
   proxy_method :receive, required: %i[account block], optional: %i[work]
-  proxy_method :send, required: %i[wallet source destination amount]
+  proxy_method :send,
+               required: %i[wallet source destination amount],
+               optional: %i[id work]
   proxy_method :search_pending
   proxy_method :wallet_add, required: %i[key], optional: %i[work]
   proxy_method :wallet_balance_total

data/lib/nano_rpc/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Nano
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nano_rpc
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Justin Craig-Kuhn (JCK)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-10 00:00:00.000000000 Z
+date: 2018-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -187,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: RPC wrapper for Nano digital nodes written in Ruby