nanook 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d14b10331b3dab85b1375935f14fdcaf55a0b88
-  data.tar.gz: e61770ece8ad4e6e7026fbfe8dea6e037dcb01c3
+  metadata.gz: 925ab6dd5294f31528ae7e0e8ce816dd8eaf625a
+  data.tar.gz: a2812f58217a0b5dd8e81f0b0db3df52ac2d04d1
 SHA512:
-  metadata.gz: 1c146f1f0e070da7e3c36bb76d9b2a312f9b8a9dc857bb786ed4425739bcc5bc59a5db6c81d7c7c6601c861039d758b254351ba82cc165f844de27c2b8822b31
-  data.tar.gz: 07d753729b387fec8974c9dc9014acea9966945aa00638346391e65fff1feb640e746d01f23450b34db8c7b8c22af2f5efab86c3dd7c0a3c25d277100918aeef
+  metadata.gz: df9564eb317b84945330e49390aacdf2a55fd631e4fdad266c55c04124a3fd0f2999ff1625aad23f314a45a33be2eb74008ce282a755a545471c67f455735de7
+  data.tar.gz: 36989a8853937febd8ad14c9b5bb3dff179725383dbf3305d6627c2af45a8fb1bbd5ba7a2882b6b5a168dd8b2a876063b380b314ba0a7beaaa369c633ba33a37

data/CHANGELOG.md

@@ -4,7 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## 1.0.1
+
+### Fixed
+
+- `Nanook::Wallet#balance(account_break_down: true)` always returning 0 `pending` balance.
+
+### Changed
+
+- Use `block.publish` in `README.md` and not the alias `block.process`.
+
+## 1.0.0
 
 ### Added
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nanook (1.0.0)
+    nanook (1.0.1)
       symbolized (~> 0.0.1)
 
 GEM
@@ -20,6 +20,7 @@ GEM
       method_source (~> 0.9.0)
     public_suffix (3.0.2)
     rake (10.5.0)
+    rdoc (6.0.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -38,6 +39,8 @@ GEM
     rspec_junit_formatter (0.3.0)
       rspec-core (>= 2, < 4, != 2.12.0)
     safe_yaml (1.0.4)
+    sdoc (1.0.0)
+      rdoc (>= 5.0)
     symbolized (0.0.1)
     webmock (3.3.0)
       addressable (>= 2.3.6)
@@ -55,6 +58,7 @@ DEPENDENCIES
   rspec (~> 3.2)
   rspec-collection_matchers (~> 1.1)
   rspec_junit_formatter (~> 0.3)
+  sdoc (~> 1.0)
   webmock (~> 3.3)
 
 BUNDLED WITH

data/README.md

@@ -62,7 +62,7 @@ Nanook.new.wallet(wallet_id).accounts
 
 ### Sending a payment
 
-You can send a payment from an account in a wallet:
+To send a payment from an account in a wallet:
 
 ```ruby
 account = Nanook.new.wallet(wallet_id).account(account_id)
@@ -80,7 +80,11 @@ The `id` can be any string and needs to be unique per payment. It serves an impo
 
 > You can (and should) specify a unique id for each spend to provide idempotency. That means that if you [make the payment call] two times with the same id, the second request won't send any additional Nano.
 
-The unit of the `amount` is NANO (which is currently technically 1Mnano — see [What are Nano's Units](https://nano.org/en/faq#what-are-nano-units-)).
+The unit of the `amount` is NANO (which is currently technically Mnano — see [What are Nano's Units](https://nano.org/en/faq#what-are-nano-units-)). You can pass an amount of raw instead by adding the `unit: :raw` argument:
+
+```ruby
+account.pay(to: recipient_account_id, amount: 999, unit: :raw, id: unique_id)
+```
 
 Note, there may be a delay in receiving a response due to Proof of Work being done. From the [Nano RPC](https://github.com/nanocurrency/raiblocks/wiki/RPC-protocol#account-create):
 
@@ -116,6 +120,8 @@ wallet.receive(block_id, into: account_id)
 
 ## All commands
 
+Below is a quick reference list of commands. See the [full Nanook documentation](https://lukes.github.io/nanook/1.0.0/) for a searchable detailed description of every class and method, what the arguments mean, and example responses (Tip: expand the "**Nanook** < Object" item in the sidebar).
+
 ### Wallets
 
 See the [full documentation for Nanook::Wallet](https://lukes.github.io/nanook/1.0.0/classes/Nanook/Wallet.html) for a detailed description of each method and example responses.
@@ -131,11 +137,6 @@ Nanook.new.wallet.create
 ```ruby
 wallet = Nanook.new.wallet(wallet_id)
 
-wallet.export
-wallet.locked?
-wallet.unlock(password)
-wallet.change_password(password)
-
 wallet.balance
 wallet.balance(account_break_down: true)
 wallet.balance(unit: :raw)
@@ -148,6 +149,11 @@ wallet.account.create
 wallet.accounts
 wallet.contains?(account_id)
 
+wallet.export
+wallet.locked?
+wallet.unlock(password)
+wallet.change_password(password)
+
 wallet.destroy
 ```
 ### Accounts
@@ -163,6 +169,15 @@ Nanook.new.wallet(wallet_id).account.create
 ```ruby
 account = Nanook.new.wallet(wallet_id).account(account_id)
 
+account.balance
+account.balance(unit: :raw)
+account.pay(to: recipient_account_id, amount: 2, id: unique_id)
+account.pay(to: recipient_account_id, amount: 2, unit: :raw, id: unique_id)
+account.pending
+account.pending(limit: 1)
+account.receive
+account.receive(pending_block_id)
+
 account.exists?
 account.info
 account.info(detailed: true)
@@ -175,15 +190,6 @@ account.delegators
 account.representative
 account.weight
 
-account.balance
-account.balance(unit: :raw)
-account.pay(to: recipient_account_id, amount: 2, id: unique_id)
-account.pay(to: recipient_account_id, amount: 2, unit: :raw, id: unique_id)
-account.pending
-account.pending(limit: 1)
-account.receive
-account.receive(pending_block_id)
-
 account.destroy
 ```
 
@@ -194,6 +200,11 @@ See the [full documentation for Nanook::Account](https://lukes.github.io/nanook/
 ```ruby
 account = Nanook.new.account(account_id)
 
+account.balance
+account.balance(unit: :raw)
+account.pending
+account.pending(limit: 1)
+
 account.exists?
 account.info
 account.info(detailed: true)
@@ -205,15 +216,12 @@ account.public_key
 account.delegators
 account.representative
 account.weight
-
-account.balance
-account.balance(unit: :raw)
-account.pending
-account.pending(limit: 1)
 ```
 
 ### Blocks
 
+See the [full documentation for Nanook::Block](https://lukes.github.io/nanook/1.0.0/classes/Nanook/Block.html) for a detailed description of each method and example responses.
+
 ```ruby
 block = Nanook.new.block(block_id)
 
@@ -228,7 +236,7 @@ block.republish
 block.republish(sources: 2)
 block.republish(destinations: 2)
 block.pending?
-block.process
+block.publish
 block.successors
 block.successors(limit: 10)
 
@@ -302,6 +310,10 @@ To run the test suite:
 
     bundle exec rspec spec
 
+To update rdoc documentation:
+
+    bundle exec rake rerdoc
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -6,9 +6,5 @@ require "nanook"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+require "pry"
+Pry.start

data/docs/1.0.0/classes/Nanook/Account.html

@@ -294,21 +294,24 @@ account = Nanook::Account.new(rpc_conn, "xrb_...")
             <div class="description">
               <p>Returns a Hash containing the account&#39;s balance. Units are in <a
 href="https://nano.org/en/faq#what-are-nano-units-">raw</a>.</p>
-<table class="rdoc-list label-list"><tbody><tr><td class='label'><code>:balance</code></td><td>
+<dl class="rdoc-list label-list"><dt><code>:balance</code>
+<dd>
 <p><a href="Account.html">Account</a> balance</p>
-</td></tr><tr><td class='label'><code>:pending</code></td><td>
+</dd><dt><code>:pending</code>
+<dd>
 <p>Amount pending and not yet received by the account</p>
-</td></tr></tbody></table>
+</dd></dl>
 
 <h4 id="method-i-balance-label-Arguments">Arguments</h4>
-<table class="rdoc-list label-list"><tbody><tr><td class='label'><code>unit:</code></td><td>
+<dl class="rdoc-list label-list"><dt><code>unit:</code>
+<dd>
 <p>Symbol (default is <code>:nano</code>) Represents the unit that the
 balances will be returned in. Must be either <code>:nano</code> or
 <code>:raw</code>. (Note: this method interprets <code>:nano</code> as
 NANO, which is technically Mnano See <a
 href="https://nano.org/en/faq#what-are-nano-units-">What are Nano’s
 Units</a>)</p>
-</td></tr></tbody></table>
+</dd></dl>
 
 <h5 id="method-i-balance-label-Example+response">Example response</h5>
 
@@ -461,10 +464,11 @@ href="Node.html#method-i-sync_progress">Nanook::Node#sync_progress</a>.</p>
 in <a href="https://nano.org/en/faq#what-are-nano-units-">raw</a>.</p>
 
 <h4 id="method-i-history-label-Arguments">Arguments</h4>
-<table class="rdoc-list label-list"><tbody><tr><td class='label'><code>limit:</code></td><td>
+<dl class="rdoc-list label-list"><dt><code>limit:</code>
+<dd>
 <p>Integer representing the maximum number of history items to return (default
 is 1000)</p>
-</td></tr></tbody></table>
+</dd></dl>
 
 <h4 id="method-i-history-label-Example">Example</h4>
 
@@ -526,7 +530,7 @@ account.history(limit: 1)
 
           
             <div class="description">
-              
+              <p>Returns the id of the account</p>
             </div>
           
 
@@ -544,7 +548,7 @@ account.history(limit: 1)
                 
               </p>
               <div id="method-i-id_source" class="dyn-source">
-                <pre><span class="ruby-comment"># File lib/nanook/account.rb, line 136</span>
+                <pre><span class="ruby-comment"># File lib/nanook/account.rb, line 137</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">id</span>
   <span class="ruby-ivar">@block</span>
 <span class="ruby-keyword">end</span></pre>
@@ -564,39 +568,50 @@ account.history(limit: 1)
           
             <div class="description">
               <p>Returns a Hash containing the following information about an account:</p>
-<table class="rdoc-list label-list"><tbody><tr><td class='label'><code>:frontier</code></td><td>
+<dl class="rdoc-list label-list"><dt><code>:frontier</code>
+<dd>
 <p>The latest block hash</p>
-</td></tr><tr><td class='label'><code>:open_block</code></td><td>
+</dd><dt><code>:open_block</code>
+<dd>
 <p>The first block in every account&#39;s blockchain. When this block was
 published the account was officially open</p>
-</td></tr><tr><td class='label'><code>:representative_block</code></td><td>
+</dd><dt><code>:representative_block</code>
+<dd>
 <p>The block that named the representative for the account</p>
-</td></tr><tr><td class='label'><code>:balance</code></td><td>
+</dd><dt><code>:balance</code>
+<dd>
 <p>Amount in <a href="https://nano.org/en/faq#what-are-nano-units-">NANO</a></p>
-</td></tr><tr><td class='label'><code>:last_modified</code></td><td>
+</dd><dt><code>:last_modified</code>
+<dd>
 <p>Unix timestamp</p>
-</td></tr><tr><td class='label'><code>:block_count</code></td><td>
+</dd><dt><code>:block_count</code>
+<dd>
 <p>Number of blocks in the account&#39;s blockchain</p>
-</td></tr></tbody></table>
+</dd></dl>
 
 <p>When <code>detailed: true</code> is passed as an argument, this method
 makes four additional calls to the RPC to return more information about an
 account:</p>
-<table class="rdoc-list label-list"><tbody><tr><td class='label'><code>:weight</code></td><td>
+<dl class="rdoc-list label-list"><dt><code>:weight</code>
+<dd>
 <p>See <a href="Account.html#method-i-weight">weight</a></p>
-</td></tr><tr><td class='label'><code>:pending</code></td><td>
+</dd><dt><code>:pending</code>
+<dd>
 <p>See <a href="Account.html#method-i-balance">balance</a></p>
-</td></tr><tr><td class='label'><code>:representative</code></td><td>
+</dd><dt><code>:representative</code>
+<dd>
 <p>See <a href="Account.html#method-i-representative">representative</a></p>
-</td></tr><tr><td class='label'><code>:public_key</code></td><td>
+</dd><dt><code>:public_key</code>
+<dd>
 <p>See <a href="Account.html#method-i-public_key">public_key</a></p>
-</td></tr></tbody></table>
+</dd></dl>
 
 <h4 id="method-i-info-label-Arguments">Arguments</h4>
-<table class="rdoc-list label-list"><tbody><tr><td class='label'><code>detailed:</code></td><td>
+<dl class="rdoc-list label-list"><dt><code>detailed:</code>
+<dd>
 <p>Boolean (default is false). When <code>true</code>, four additional calls
 are made to the RPC to return more information</p>
-</td></tr></tbody></table>
+</dd></dl>
 
 <h4 id="method-i-info-label-Example+1">Example 1</h4>
 
@@ -652,7 +667,7 @@ are made to the RPC to return more information</p>
                 
               </p>
               <div id="method-i-info_source" class="dyn-source">
-                <pre><span class="ruby-comment"># File lib/nanook/account.rb, line 196</span>
+                <pre><span class="ruby-comment"># File lib/nanook/account.rb, line 197</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">info</span>(<span class="ruby-value">detailed:</span> <span class="ruby-keyword">false</span>)
   <span class="ruby-identifier">account_required!</span>
 
@@ -695,9 +710,10 @@ the ledger. The number of accounts returned is determined by the
 href="Account.html#method-i-info">info</a>(detailed: false) method returns.</p>
 
 <h4 id="method-i-ledger-label-Arguments">Arguments</h4>
-<table class="rdoc-list label-list"><tbody><tr><td class='label'><code>limit:</code></td><td>
+<dl class="rdoc-list label-list"><dt><code>limit:</code>
+<dd>
 <p>Number of accounts to return in the ledger (default is 1)</p>
-</td></tr></tbody></table>
+</dd></dl>
 
 <h4 id="method-i-ledger-label-Example">Example</h4>
 
@@ -735,7 +751,7 @@ href="Account.html#method-i-info">info</a>(detailed: false) method returns.</p>
                 
               </p>
               <div id="method-i-ledger_source" class="dyn-source">
-                <pre><span class="ruby-comment"># File lib/nanook/account.rb, line 247</span>
+                <pre><span class="ruby-comment"># File lib/nanook/account.rb, line 248</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ledger</span>(<span class="ruby-value">limit:</span> <span class="ruby-value">1</span>)
   <span class="ruby-identifier">account_required!</span>
   <span class="ruby-identifier">rpc</span>(<span class="ruby-value">:ledger</span>, <span class="ruby-value">count:</span> <span class="ruby-identifier">limit</span>)[<span class="ruby-value">:accounts</span>]
@@ -765,12 +781,14 @@ href="https://nano.org/en/faq#what-are-nano-units-">raw</a> of the pending
 block and the source account that sent it.</p>
 
 <h4 id="method-i-pending-label-Arguments">Arguments</h4>
-<table class="rdoc-list label-list"><tbody><tr><td class='label'><code>limit:</code></td><td>
+<dl class="rdoc-list label-list"><dt><code>limit:</code>
+<dd>
 <p>Number of pending blocks to return (default is 1000)</p>
-</td></tr><tr><td class='label'><code>detailed:</code></td><td>
+</dd><dt><code>detailed:</code>
+<dd>
 <p>Boolean to have this method return a more complex Hash of pending block
 information (default is <code>false</code>)</p>
-</td></tr></tbody></table>
+</dd></dl>
 
 <h4 id="method-i-pending-label-Example+1">Example 1</h4>
 
@@ -813,7 +831,7 @@ information (default is <code>false</code>)</p>
                 
               </p>
               <div id="method-i-pending_source" class="dyn-source">
-                <pre><span class="ruby-comment"># File lib/nanook/account.rb, line 288</span>
+                <pre><span class="ruby-comment"># File lib/nanook/account.rb, line 289</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pending</span>(<span class="ruby-value">limit:</span> <span class="ruby-value">1000</span>, <span class="ruby-value">detailed:</span> <span class="ruby-keyword">false</span>)
   <span class="ruby-identifier">account_required!</span>
 
@@ -951,7 +969,7 @@ if it is a representative.</p>
                 
               </p>
               <div id="method-i-weight_source" class="dyn-source">
-                <pre><span class="ruby-comment"># File lib/nanook/account.rb, line 304</span>
+                <pre><span class="ruby-comment"># File lib/nanook/account.rb, line 305</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">weight</span>
   <span class="ruby-identifier">account_required!</span>
   <span class="ruby-identifier">rpc</span>(<span class="ruby-value">:account_weight</span>)[<span class="ruby-value">:weight</span>]