nanook 1.0.2 → 2.0.0

data/lib/nanook/wallet_account.rb

@@ -1,25 +1,22 @@
 class Nanook
   class WalletAccount
 
-    UNITS = [:raw, :nano]
-    DEFAULT_UNIT = :nano
-
     def initialize(rpc, wallet, account)
       @rpc = rpc
       @wallet = wallet
       @account = account
-
-      # An object to delegate account methods that don't
-      # expect a wallet param in the RPC call, to allow this
-      # class to support all methods that can be called on Nanook::Account
-      @nanook_account_instance = Nanook::Account.new(@rpc, @account)
-
-      # Wallet instance to call contains? on to check account
-      # is in wallet
-      @nanook_wallet_instance = Nanook::Wallet.new(@rpc, @wallet)
-
-      if @account
-        account_must_belong_to_wallet!
+      @nanook_account_instance = nil
+
+      unless @account.nil?
+        # Wallet must contain the account
+        unless Nanook::Wallet.new(@rpc, @wallet).contains?(@account)
+          raise ArgumentError.new("Account does not exist in wallet. Account: #{@account}, wallet: #{@wallet}")
+        end
+
+        # An object to delegate account methods that don't
+        # expect a wallet param in the RPC call, to allow this
+        # class to support all methods that can be called on Nanook::Account
+        @nanook_account_instance = Nanook::Account.new(@rpc, @account)
       end
     end
 
@@ -27,26 +24,43 @@ class Nanook
       @account
     end
 
-    def create
-      wallet_required!
-      rpc(:account_create)[:account]
+    # Create a new account in this wallet.
+    #
+    # ==== Example:
+    #
+    #   wallet.create    # => Create 1 account, and return the {Nanook::WalletAccount}
+    #   wallet.create(2) # => Create 2 accounts, and return an Array of {Nanook::WalletAccount}
+    #
+    # @param n [Integer] number of accounts to create (default is 1)
+    #
+    # @return [Nanook::WalletAccount] will return a single {Nanook::WalletAccount}
+    #   unless method was called with
+    # @return [Array<Nanook::WalletAccount>] will return an Array of {Nanook::WalletAccount}
+    #   if method was called with
+    def create(n=1)
+      if n < 1
+        raise ArgumentError.new("number of accounts must be greater than 1")
+      end
+
+      if n == 1
+        Nanook::WalletAccount.new(@rpc, @wallet, rpc(:account_create)[:account])
+      else
+        Array(rpc(:accounts_create, count: n)[:accounts]).map do |account|
+          Nanook::WalletAccount.new(@rpc, @wallet, account)
+        end
+      end
     end
 
     def destroy
-      wallet_required!
-      (rpc(:account_remove)[:removed] == 1).tap do |success|
-        @known_valid_accounts.delete(@account) if success
-      end
+      rpc(:account_remove)[:removed] == 1
     end
 
-    def inspect # :nodoc:
+    def inspect
       "#{self.class.name}(wallet_id: #{wallet_id}, account_id: #{account_id}, object_id: \"#{"0x00%x" % (object_id << 1)}\")"
     end
 
-    def pay(to:, amount:, unit: DEFAULT_UNIT, id:)
-      wallet_required!
-
-      unless UNITS.include?(unit)
+    def pay(to:, amount:, unit: Nanook::default_unit, id:)
+      unless Nanook::UNITS.include?(unit)
         raise ArgumentError.new("Unsupported unit: #{unit}")
       end
 
@@ -81,8 +95,6 @@ class Nanook
 
     # Returns false if no block to receive
     def receive(block=nil)
-      wallet_required!
-
       if block.nil?
         _receive_without_block
       else
@@ -90,6 +102,39 @@ class Nanook
       end
     end
 
+    # Sets the representative for the account.
+    #
+    # A representative is an account that will vote on your account's
+    # behalf on the nano network if your account is offline and there is
+    # a fork of the network that requires voting on.
+    #
+    # Returns a String of the <em>change block</em> that was
+    # broadcast to the nano network. The block contains the information
+    # about the representative change for your account.
+    #
+    # Will throw an +ArgumentError+ if the representative account does not
+    # exist.
+    #
+    # ==== Arguments
+    # [+representative+] String of a representative account (starting with
+    #                    <tt>"xrb..."</tt>) to set as this account's representative.
+    #
+    # ==== Example
+    #
+    #   account.change_representative("xrb_...")
+    #
+    # ==== Example response
+    #
+    #   "000D1BAEC8EC208142C99059B393051BAC8380F9B5A2E6B2489A277D81789F3F"
+    def change_representative(representative)
+      # Check that representative is valid
+      unless Nanook::Account.new(@rpc, representative).exists?
+        raise ArgumentError.new("Representative account does not exist (#{representative})")
+      end
+
+      rpc(:account_representative_set, representative: representative)[:block]
+    end
+
     def wallet_id
       @wallet
     end
@@ -132,28 +177,5 @@ class Nanook
       @rpc.call(action, p.merge(params))
     end
 
-    def wallet_required!
-      if @wallet.nil?
-        raise ArgumentError.new("Wallet must be present")
-      end
-    end
-
-    def account_must_belong_to_wallet!
-      if @account.nil?
-        raise ArgumentError.new("Account must be present")
-      end
-
-      @known_valid_accounts ||= []
-
-      # validate account is in wallet
-      return if @known_valid_accounts.include?(@account)
-
-      if @nanook_wallet_instance.contains?(@account)
-        @known_valid_accounts << @account
-      else
-        raise ArgumentError.new("Account does not exist in wallet. Account: #{@account}, wallet: #{@wallet}")
-      end
-    end
-
   end
 end

data/lib/nanook/work_peer.rb

@@ -13,7 +13,7 @@ class Nanook
       rpc(:work_peers_clear).has_key?(:success)
     end
 
-    def inspect # :nodoc:
+    def inspect
       "#{self.class.name}(object_id: \"#{"0x00%x" % (object_id << 1)}\")"
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanook
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Luke Duncalfe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-15 00:00:00.000000000 Z
+date: 2018-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,14 +28,14 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -95,33 +95,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: sdoc
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: symbolized
   requirement: !ruby/object:Gem::Requirement
@@ -144,18 +144,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".gitignore"
-- ".rspec"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/console
 - bin/setup
-- img/qr.png
 - lib/nanook.rb
 - lib/nanook/account.rb
 - lib/nanook/block.rb
@@ -168,11 +161,11 @@ files:
 - lib/nanook/wallet.rb
 - lib/nanook/wallet_account.rb
 - lib/nanook/work_peer.rb
-- nanook.gemspec
 homepage: https://github.com/lukes/nanook
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -181,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -192,6 +185,6 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Ruby library for managing a nano currency node, including making and receiving
+summary: Library for managing a nano currency node, including making and receiving
   payments, using the nano RPC protocol
 test_files: []

data/.circleci/config.yml

@@ -1,56 +0,0 @@
-# Ruby CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-ruby/ for more details
-#
-version: 2
-jobs:
-  build:
-    docker:
-      # specify the version you desire here
-       - image: circleci/ruby:2.4.1-node-browsers
-
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/postgres:9.4
-
-    working_directory: ~/repo
-
-    steps:
-      - checkout
-
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      # Database setup
-      # - run: bundle exec rake db:create
-      # - run: bundle exec rake db:schema:load
-
-      # run tests!
-      - run:
-          name: run tests
-          command: |
-            mkdir /tmp/test-results
-
-            bundle exec rspec spec --format progress --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
-
-      # collect reports
-      - store_test_results:
-          path: /tmp/test-results
-      - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/tmp/
-.ruby-version

data/.rspec

@@ -1 +0,0 @@
---require spec_helper

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in nanook.gemspec
-gemspec

data/Gemfile.lock

@@ -1,65 +0,0 @@
-PATH
-  remote: .
-  specs:
-    nanook (1.0.2)
-      symbolized (~> 0.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    coderay (1.1.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    hashdiff (0.3.7)
-    method_source (0.9.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      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)
-      rspec-mocks (~> 3.7.0)
-    rspec-collection_matchers (1.1.3)
-      rspec-expectations (>= 2.99.0.beta1)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    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)
-      crack (>= 0.3.2)
-      hashdiff
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  nanook!
-  pry
-  rake (~> 10.0)
-  rspec (~> 3.2)
-  rspec-collection_matchers (~> 1.1)
-  rspec_junit_formatter (~> 0.3)
-  sdoc (~> 1.0)
-  webmock (~> 3.3)
-
-BUNDLED WITH
-   1.16.1

data/Rakefile

@@ -1,20 +0,0 @@
-require "bundler/gem_tasks"
-task :default => :spec
-
-require 'sdoc' # sdoc https://github.com/zzak/sdoc
-require 'rdoc/task'
-require 'nanook/version'
-
-#
-# Note: `rake rerdoc`` forces a fresh generation of docs
-#
-
-RDoc::Task.new do |rdoc|
-  rdoc.main = 'README.md' # index page
-  rdoc.title = "Nanook #{Nanook::VERSION} Documentation"
-  rdoc.rdoc_files.include("README.md")
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.rdoc_dir = "docs/#{Nanook::VERSION}" # name of output directory
-  rdoc.generator = 'sdoc' # explictly set the sdoc generator
-  rdoc.template = 'rails' # template used on api.rubyonrails.org
-end