nano_rpc 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51594de4d5c25a44368e84aea129bfe04cc01f28654efdd70101a77b86361111
-  data.tar.gz: 3dcedfce43a868796ea107807a4a196cd4e78d5416ebaae4289d3911fbbb8a88
+  metadata.gz: d10073bf6ebd0cca384ce4de513f53f7356bbf289731f8dcdf322496a6089e68
+  data.tar.gz: '059b36ad240027dc29f655a9bdb07649b79e7279712472b508baeb09a31e5df1'
 SHA512:
-  metadata.gz: 5df2f32a0c02eada1f18af7d460de1d01b1e9cf762091168047855cba46f002dbcda51f42c662ff29a1dbddc31ac14b0dbe1725d9602a57e2726bab4f650f214
-  data.tar.gz: d0cdd6a9ba34c543f8cd7039abc6e0cc368ea862e2770cfceb2f49c9cb8af538570eea14d870c7dc1aab1012fe359ee92970df819ac5b9a8c0e59351f61b8191
+  metadata.gz: 2de3f22e5b894b2e421fe93f5b424b646807b8ec9b1e3fda89108eaaa589a48c1ee46eecaf00f615d593a9d0d48f9fe234118773d686e03c21b732bceae44b3b
+  data.tar.gz: cd8780df5f4ce82724aa42c12cc2183c9440e30d3961f5e9a25abe48895c124097f26e0d86b6b7ac5f98dd73357325045a857ee9e734cd2b7a1f46d58029ac21

data/README.md

@@ -1,8 +1,6 @@
-# Nano RPC
+![Ruby Nano RPC Logo](https://i.imgur.com/ihmmYcp.png)
 
-![Ruby Logo](https://i.imgur.com/pTKxwQq.png)
-
-An RPC wrapper for Nano digitial currency nodes written in Ruby. 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/Proxy-Object-Reference)).
 
 To run a Nano node locally, see [Nano Docker Docs](https://github.com/clemahieu/raiblocks/wiki/Docker-node).
 
@@ -100,6 +98,10 @@ You can point each proxy object at its own node by passing in a client instance:
 
 For a comprehensive guide, see the [Wiki](https://github.com/jcraigk/ruby_nano_rpc/wiki).
 
+## Credits
+
+Logo created by Andrei Luca ([Twitter](https://twitter.com/lucandrei_))
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/nano_rpc/client.rb

@@ -25,12 +25,31 @@ module Nano
     def call(action, params = {})
       args = { action: action }
       args.merge!(params) if params.is_a?(Hash)
-      post(args)
+      args = extract_proxy_args(args)
+      rpc_post(args)
     end
 
     private
 
-    def post(params)
+    def extract_proxy_args(args)
+      args.each do |k, v|
+        m = proxy_method(v)
+        args[k] = v.send(m) if m
+      end
+      args
+    end
+
+    def proxy_method(v)
+      if v.is_a?(Nano::Wallet)
+        :seed
+      elsif v.is_a?(Nano::Accounts)
+        :addresses
+      elsif v.is_a?(Nano::Account)
+        :address
+      end
+    end
+
+    def rpc_post(params)
       response = rest_client_post(url, params)
       ensure_status_success!(response)
 
@@ -45,6 +64,9 @@ module Nano
     rescue Errno::ECONNREFUSED
       raise Nano::NodeConnectionFailure,
             "Node connection failure at #{url}"
+    rescue RestClient::Exceptions::OpenTimeout
+      raise Nano::NodeOpenTimeout,
+            'Node failed to respond in time'
     end
 
     def url

data/lib/nano_rpc/errors.rb

@@ -7,4 +7,5 @@ module Nano
   class InvalidRequest < Error; end
   class ForbiddenParameter < Error; end
   class MissingParameters < Error; end
+  class NodeOpenTimeout < Error; end
 end

data/lib/nano_rpc/helpers/account_helper.rb

@@ -10,10 +10,8 @@ module Nano::AccountHelper
     account_block_count.block_count
   end
 
-  def history(*args)
-    account_history(
-      pluck_argument(args, :count)
-    ).history
+  def history(count:)
+    account_history(count: count).history
   end
 
   def info
@@ -26,17 +24,14 @@ module Nano::AccountHelper
 
   def move(from:, to:)
     account_move(
-      wallet: object_to_value(to),
-      source: object_to_value(from),
+      source: from,
+      wallet: to,
       accounts: [address]
     ).moved == 1
   end
 
   def wallet_work_set(wallet:, work:)
-    work_set(
-      wallet: object_to_value(wallet),
-      work: work
-    ).success == ''
+    work_set(wallet: wallet, work: work).success == ''
   end
 
   def pending_balance
@@ -53,10 +48,8 @@ module Nano::AccountHelper
   end
   alias blocks_pending pending_blocks
 
-  def remove(*args)
-    account_remove(
-      pluck_argument(args, :wallet)
-    ).removed == 1
+  def remove(wallet:)
+    account_remove(wallet: wallet).removed == 1
   end
 
   def representative
@@ -65,7 +58,7 @@ module Nano::AccountHelper
 
   def representative_set(wallet:, representative:)
     account_representative_set(
-      wallet: object_to_value(wallet),
+      wallet: wallet,
       representative: representative
     ).set == 1
   end

data/lib/nano_rpc/helpers/accounts_helper.rb

@@ -24,15 +24,14 @@ module Nano::AccountsHelper
   end
 
   def move(from:, to:)
-    account_move(
-      source: object_to_value(from),
-      wallet: object_to_value(to)
-    ).moved == 1
+    account_move(source: from, wallet: to).moved == 1
   end
 
   def pending(count:, threshold: nil, source: nil)
     accounts_pending(
-      count: count, threshold: threshold, source: source
+      count: count,
+      threshold: threshold,
+      source: source
     ).blocks
   end
   alias pending_blocks pending
@@ -41,7 +40,7 @@ module Nano::AccountsHelper
   def [](idx)
     return unless @addresses[idx]
     @account_objects ||= []
-    @account_objects[idx] ||= Nano::Account.new(@addresses[idx])
+    @account_objects[idx] ||= Nano::Account.new(@addresses[idx], client: client)
   end
 
   def <<(val)
@@ -50,7 +49,7 @@ module Nano::AccountsHelper
 
   def each(&_block)
     @addresses.each do |address|
-      yield Nano::Account.new(address)
+      yield Nano::Account.new(address, client: client)
     end
   end
 

data/lib/nano_rpc/helpers/application_helper.rb

@@ -2,25 +2,6 @@
 module Nano::ApplicationHelper
   private
 
-  def pluck_argument(args, key, arg_key = nil)
-    k = arg_key || key
-    arg = args.first
-    v = arg.is_a?(Hash) ? arg[key] : arg
-    { k => object_to_value(v) }
-  end
-
-  def object_to_value(arg)
-    if arg.is_a?(Nano::Wallet)
-      arg.seed
-    elsif arg.is_a?(Nano::Account)
-      arg.address
-    elsif arg.is_a?(Nano::Accounts)
-      arg.addresses
-    else
-      arg
-    end
-  end
-
   def inspect_prefix
     "#<#{self.class}:#{format('0x00%x', object_id << 1)}"
   end

data/lib/nano_rpc/helpers/node_helper.rb

@@ -2,44 +2,44 @@
 module Nano::NodeHelper
   include Nano::ApplicationHelper
 
-  def account_containing_block(*args)
-    block_account(pluck_argument(args, :hash)).account
+  def account_containing_block(hash:)
+    block_account(hash: hash).account
   end
 
   def create_wallet
-    Nano::Wallet.new(wallet_create.wallet)
+    Nano::Wallet.new(wallet_create.wallet, client: client)
   end
 
-  def knano_from_raw(*args)
-    krai_from_raw(pluck_argument(args, :amount)).amount
+  def knano_from_raw(amount:)
+    krai_from_raw(amount: amount).amount
   end
 
-  def knano_to_raw(*args)
-    krai_to_raw(pluck_argument(args, :amount)).amount
+  def knano_to_raw(amount:)
+    krai_to_raw(amount: amount).amount
   end
 
-  def mnano_from_raw(*args)
-    mrai_from_raw(pluck_argument(args, :amount)).amount
+  def mnano_from_raw(amount:)
+    mrai_from_raw(amount: amount).amount
   end
 
-  def mnano_to_raw(*args)
-    mrai_to_raw(pluck_argument(args, :amount)).amount
+  def mnano_to_raw(amount:)
+    mrai_to_raw(amount: amount).amount
   end
 
-  def nano_from_raw(*args)
-    rai_from_raw(pluck_argument(args, :amount)).amount
+  def nano_from_raw(amount:)
+    rai_from_raw(amount: amount).amount
   end
 
-  def nano_to_raw(*args)
-    rai_to_raw(pluck_argument(args, :amount)).amount
+  def nano_to_raw(amount:)
+    rai_to_raw(amount: amount).amount
   end
 
   def num_frontiers
     frontier_count['count']
   end
 
-  def pending_exists?(*args)
-    pending_exists(pluck_argument(args, :hash)).exists == 1
+  def pending_exists?(hash:)
+    pending_exists(hash: hash).exists == 1
   end
 
   def total_supply

data/lib/nano_rpc/helpers/wallet_helper.rb

@@ -2,13 +2,13 @@
 module Nano::WalletHelper
   include Nano::ApplicationHelper
 
-  def account_work(*args)
-    work_get(pluck_argument(args, :account)).work
+  def account_work(account:)
+    work_get(account: account).work
   end
 
   def accounts
     return [] unless account_list.accounts.size.positive?
-    Nano::Accounts.new(account_list.accounts)
+    Nano::Accounts.new(account_list.accounts, client: client)
   end
 
   def add_key(key:, work: true)
@@ -31,36 +31,34 @@ module Nano::WalletHelper
     payment_begin.account
   end
 
-  def change_password(*args)
-    password_change(
-      pluck_argument(args, :new_password, :password)
-    ).changed == 1
+  def change_password(new_password:)
+    password_change(password: new_password).changed == 1
   end
 
-  def change_seed(*args)
-    wallet_change_seed(
-      pluck_argument(args, :new_seed, :seed)
-    ).success == ''
+  def change_seed(new_seed:)
+    wallet_change_seed(seed: new_seed).success == ''
   end
 
-  def contains?(*args)
-    wallet_contains(pluck_argument(args, :account)).exists == 1
+  def contains?(account:)
+    wallet_contains(account: account).exists == 1
   end
 
   def create_account(work: true)
-    Nano::Account.new(account_create(work: work).account)
+    address = account_create(work: work).account
+    Nano::Account.new(address, client: client)
   end
 
   def create_accounts(count:, work: true)
-    Nano::Accounts.new(accounts_create(count: count, work: work).accounts)
+    addresses = accounts_create(count: count, work: work).accounts
+    Nano::Accounts.new(addresses, client: client)
   end
 
   def destroy
     wallet_destroy
   end
 
-  def enter_password(*args)
-    password_enter(pluck_argument(args, :password)).valid == 1
+  def enter_password(password:)
+    password_enter(password: password).valid == 1
   end
 
   def export
@@ -80,15 +78,11 @@ module Nano::WalletHelper
   end
 
   def move_accounts(to:, accounts:)
-    account_move(
-      wallet: object_to_value(to),
-      source: seed,
-      accounts: object_to_value(accounts)
-    ).moved == 1
+    account_move(wallet: to, source: seed, accounts: accounts).moved == 1
   end
 
-  def password_valid?(*args)
-    password_valid(pluck_argument(args, :password)).valid == 1
+  def password_valid?(password:)
+    password_valid(password: password).valid == 1
   end
 
   def pending_balance
@@ -116,42 +110,37 @@ module Nano::WalletHelper
 
   def receive_block(account:, block:)
     receive(
-      account: object_to_value(account),
+      account: account,
       block: block
     ).block
   end
 
-  def remove_account(*args)
-    account_remove(pluck_argument(args, :account)).removed == 1
+  def remove_account(account:)
+    account_remove(account: account).removed == 1
   end
 
   def representative
     wallet_representative.representative
   end
 
-  def republish(*args)
-    wallet_republish(pluck_argument(args, :count)).blocks
+  def republish(count:)
+    wallet_republish(count: count).blocks
   end
 
   def account_work_set(account:, work:)
-    work_set(
-      account: object_to_value(account),
-      work: work
-    ).success == ''
+    work_set(account: account, work: work).success == ''
   end
   alias set_account_work account_work_set
 
-  def representative_set(*args)
-    wallet_representative_set(
-      pluck_argument(args, :representative)
-    ).set == 1
+  def representative_set(representative:)
+    wallet_representative_set(representative: representative).set == 1
   end
   alias set_representative representative_set
 
   def send_nano(from:, to:, amount:, work: nil)
     send_currency(
-      source: object_to_value(from),
-      destination: object_to_value(to),
+      source: from,
+      destination: to,
       amount: amount,
       work: work
     ).block

data/lib/nano_rpc/proxies/account.rb

@@ -37,6 +37,7 @@ class Nano::Account
   proxy_method :validate_account_number
   proxy_method :pending, required: %i[count], optional: %i[threshold exists]
   proxy_method :payment_wait, required: %i[amount timeout]
-  proxy_method :work_get
+  proxy_method :receive, required: %i[wallet block], optional: %i[work]
+  proxy_method :work_get, required: %i[wallet]
   proxy_method :work_set
 end

data/lib/nano_rpc/proxies/wallet.rb

@@ -50,6 +50,6 @@ class Nano::Wallet
   proxy_method :wallet_representative_set, required: %i[representative]
   proxy_method :wallet_republish, required: %i[count]
   proxy_method :wallet_work_get
-  proxy_method :work_get
+  proxy_method :work_get, required: %i[account]
   proxy_method :work_set
 end

data/lib/nano_rpc/proxy.rb

@@ -6,7 +6,7 @@ module Nano::Proxy
 
   def initialize(opts = {})
     @client = opts[:client] || Nano.client
-    self.class.proxy_methods.each { |m| define_proxy_method(m) }
+    self.class.proxy_methods&.each { |m| define_proxy_method(m) }
   end
 
   def self.included(base)
@@ -25,7 +25,7 @@ module Nano::Proxy
     end
 
     def proxy_methods
-      proxy_method_def.keys.sort
+      proxy_method_def&.keys&.sort
     end
   end
 
@@ -36,24 +36,15 @@ module Nano::Proxy
   private
 
   def define_proxy_method(m)
-    self.class.send(:define_method, method_alias(m)) do |*args|
+    self.class.send(:define_method, method_alias(m)) do |args = {}|
       @m = m
-      @call_args = hashify_args(args)
+      @call_args = args
 
       validate_params!
       execute_call
     end
   end
 
-  def hashify_args(args)
-    if args.first.is_a?(Hash)
-      args.first
-    else
-      (args[1].is_a?(Hash) ? args[1] : {})
-        .merge!(pluck_argument(args, required_params.first))
-    end
-  end
-
   def execute_call
     expose_nested_data(@client.call(@m, @call_args))
   end

data/lib/nano_rpc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nano_rpc
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Justin Craig-Kuhn (JCK)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2018-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler