blockchain 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a92813c9ae48afa6b214434774c53a23b75be82
-  data.tar.gz: 2cc22009b6e5573682c72e666be18dcb2635897b
+  metadata.gz: ad92df1e084cfe05666bfc1b54bcde999de70dec
+  data.tar.gz: 2ec38849a086345f5824a654428d38ac4dcbb6e5
 SHA512:
-  metadata.gz: 0e89dcad42091a11a0700423540d9bad795a7deea3cd996cb020780fc1cdab0e2d8d9f49592317473778714be30c091200dea7019057287a0d3b7bf02e19efa2
-  data.tar.gz: 8211b24abb62df05bbf0accbb6451f10e426d8b41b99f602785c055476d52b60b64bf506c24b79bf94a5568e0ce7f56e4097644226559787213a9e548f952e56
+  metadata.gz: 5dc36e728ed3219a0a0c6b72d232932de48a3c6c499faa41e3ac2ef3c57786013c45cf3fa69a7930283c9e0dad976dc256a0b8f229cce0a82dcffa0050266f4f
+  data.tar.gz: 3aa3343bd6f4aeb6ea26e66ba4dc1f064d86e27f221a9334ce35b801d585c1d9cb70e82ade16845bd22f6b5c3d9a61e792e8382941f699f917b099d175cb1394

data/README.md

@@ -1,8 +1,12 @@
-#Blockchain API library (Ruby, v1)
+# Blockchain API library (Ruby, v1)
 
 An official Ruby gem for interacting with the Blockchain.info API.
 
-###Getting started
+### Release notes
+
+This gem was recently updated to support additional functionality of the Blockchain API. As part of this process, the archticture was changed. Rather than calling static methods under the Blockchain module, applications can now create instances of different classes supporting different Blockchain API endpoints. Calling the static methods will still work, but these have been deprecated.
+
+### Getting started
 
 Installation via RubyGems:
 
@@ -31,20 +35,33 @@ The gem consists of the following functionality:
 
 The main module is called `Blockchain`
 
-###Error handling
+### The Client class
+
+Every class instance creates an instance of the client class, which is used to make calls to the API. The client instance will be created with a default base url if none is provided. You can also provide an API code when creating an instance of any class. For example:
+
+```ruby
+require 'Blockchain'
+
+# creates a block explorer instance pointing to the default base url, https://blockchain.info/, with no api code
+explorer = Blockchain::BlockExplorer.new
+# creates a block explorer pointing to an alternative base url and using an api code
+explorer = Blockchain::BlockExplorer.new('http://some-other-url.com/', 'api-code')
+```
+
+### Error handling
 
 All functions may raise exceptions caused by incorrectly passed parameters or other problems. If a call is rejected server-side, the `APIException` exception will be raised.
 
-###Connection timeouts
+### Connection timeouts
 
 It is possible to set arbitrary connection timeouts.
 
 ```ruby
-require 'blockchain'
+require 'Blockchain'
 Blockchain::TIMEOUT_SECONDS = 5 #time out after 5 seconds
 ```
 
-###Request limits and API keys
+### Request limits and API keys
 
 In order to prevent abuse some API methods require an API key approved with some basic contact information and a description of its intended use. Please request an API key [here](https://blockchain.info/api/api_create_code).
 

data/Rakefile

@@ -1,10 +1,9 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
-begin
-  require 'rspec/core/rake_task'
-
-  RSpec::Core::RakeTask.new(:spec)
-
-  task :default => :spec
-rescue LoadError
+Rake::TestTask.new do |t|
+	t.libs << "test"
 end
+
+desc "Running Tests"
+task :default => :test

data/blockchain.gemspec

@@ -20,6 +20,4 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency 'rspec', '~> 3.4'
-
-end
+end

data/docs/blockexplorer.md

@@ -1,117 +1,288 @@
-##Block explorer functionality
+# Block Explorer functionality
 
-All functions support an optional parameter called `api_code`. It won't be listed with every function description.
+Initialize an instance of the `BlockExplorer` class:
 
-####`get_block`
-Get a single block based on a block index or hash. Returns a `Block` object.
+```ruby
+require 'Blockchain'
 
-Params: 
-```
-block_id : str - block index or hash
+# create an instance pointing to https://blockchain.info/ with no api code
+explorer = Blockchain::BlockExplorer.new
+
+# create an instance potining to https://blockchain.info/ with an api code
+explorer = Blockchain::BlockExplorer.new(api_code = 'your-api-code')
+
+# create an instance pointing to an alternative base url with no api code
+explorer = Blockchain::BlockExplorer.new('http://some-alternative-url')
+
+# create an instance pointing to an alternative base url with an api code
+explorer = Blockchain::BlockExplorer.new('http://some-alternative-url', 'your-api-code')
 ```
 
-Usage:
-```ruby
-require 'blockchain'
+## Methods
+
+### `get_block_by_index`
+
+Get a single block based on a block index. Returns a `Block` object. (Deprecated)
 
-block = Blockchain::get_block('000000000000000016f9a2c3e0f4c1245ff24856a79c34806969f5084f410680')
+##### Params:
+* `int block_index`
+
+##### Usage:
+```ruby
+explorer.get_block_by_index(1486749)
 ```
 
-####`get_tx`
-Get a single transaction based on a transaction index or hash. Returns a `Transaction` object.
+### `get_block_by_hash`
+
+Get a single block based on a block hash. Returns a `Block` object.
+
+##### Params:
+* `str block_hash`
 
-Params:
+##### Usage:
+```ruby
+explorer.get_block_by_hash('000000000000000016f9a2c3e0f4c1245ff24856a79c34806969f5084f410680')
 ```
-tx_id : str - transaction index or hash
+
+### `get_tx_by_index`
+
+Get a single transaction based on a transaction index. Returns a `Transaction` object. (Deprecated)
+
+##### Params:
+* `int tx_index`
+
+##### Usage:
+```ruby
+explorer.get_tx_by_index(243169766)
 ```
 
-Usage:
+### `get_tx_by_hash`
+
+Get a single transaction based on a transaction hash. Returns a `Transaction` object.
+
+##### Params:
+* `str tx_hash`
+
+##### Usage:
 ```ruby
-tx = Blockchain::get_tx('d4af240386cdacab4ca666d178afc88280b620ae308ae8d2585e9ab8fc664a94')
+explorer.get_tx_by_hash('d4af240386cdacab4ca666d178afc88280b620ae308ae8d2585e9ab8fc664a94')
 ```
 
-####`get_block_height`
+### `get_block_height`
+
 Get an array of blocks at the specified height. Returns an array of `Block` objects.
 
-Params:
-```
-height : int - block height
-```
+##### Params:
+* `int height`
 
-Usage:
+##### Usage:
 ```ruby
-blocks = Blockchain::get_block_height(2570)
+explorer.get_block_height(2570)
 ```
 
-####`get_address`
-Get a single address and its transactions. Returns an `Address` object.
+---
+### Get Address
 
-Params:
-```
-address : str - address in the base58 or hash160 format
-```
+The implementations of these methods are currently interchangeable, but this is liable to change in the future. All address methods accept the following optional parameters:
+
+* `int limit` - the number of transactions to limit the response to (max. 50, default 50 for a single address, max. 100, default 100 for multiple addresses)
+* `int offset` - skip the first n transactions (default 0). This can be used to get more than the maximum number of transactions
+* `FilterType filter` - type of filter to use for the query (default FilterType::REMOVE_UNSPENDABLE)
+
+### `get_address_by_hash160`
 
-Usage:
+Get a single hash160 address and its transactions. Returns an `Address` object.
+
+##### Params:
+* `str address` - address in hash160 format
+
+##### Usage:
 ```ruby
-address = Blockchain::get_address('1HS9RLmKvJ7D1ZYgfPExJZQZA1DMU3DEVd')
+explorer.get_address_by_hash160('5ddda1c11ce7df6681cb064cf9aab5d6df44bb1b')
 ```
 
-####`get_unspent_outputs`
-Get an array of unspent outputs for an address. Returns an array of `UnspentOutput` objects.
+### `get_address_by_base58`
 
-Params:
-```
-address : str - address in the base58 or hash160 format
-```
+Get a single base58check address and its transactions. Returns an `Address` object.
 
-Usage:
+##### Params:
+* `str address` - address in base58check format
+
+##### Usage:
 ```ruby
-outs = Blockchain::get_unspent_outputs('1HS9RLmKvJ7D1ZYgfPExJZQZA1DMU3DEVd')
+explorer.get_address_by_base58('19ZKM6JFvCiBQbqqHPzRDLGHpN6wkQnXDs')
 ```
 
-####`get_latest_block`
-Get the latest block on the main chain. Returns a `LatestBlock` object.
+### `get_xpub`
+
+Get the xPub summary with its overall balanace and transactions. Returns a `Xpub` object.
+
+##### Params:
+* `str xpub` - xPub address
 
-Usage:
+##### Usage:
 ```ruby
-latest_block = Blockchain::get_latest_block()
+explorer.get_xpub('xpub6CmZamQcHw2TPtbGmJNEvRgfhLwitarvzFn3fBYEEkFTqztus7W7CNbf48Kxuj1bRRBmZPzQocB6qar9ay6buVkQk73ftKE1z4tt9cPHWRn')
 ```
 
-####`get_unconfirmed_tx`
-Get a list of currently unconfirmed transactions. Returns an array of `Transaction` objects.
+### `get_multi_address`
 
-Usage:
+Get data for multiple base58check and / or xpub addresses. Returns a `MultiAddress` object.
+
+##### Params:
+* `str[] address_array`
+
+##### Usage:
 ```ruby
-txs = Blockchain::get_unconfirmed_tx()
+address_array = ['1C48NriBmPVvgCk1V5eNCS82zbSrKoPLbK', '1MyAwSkfdnTsV2uAsHiHMNcxqYhtWwNWSQ', '1Dn5EfV8bvfNu7HQ9iKr467nPFRiogKv9G']
+explorer.get_multi_address(address_array)
 ```
+---
 
-####`get_blocks`
-Get a list of blocks for a specific day or mining pool. Returns an array of `SimpleBlock` objects.
+### `get_unspent_outputs`
 
-Params:
-```
-time : int - unix time in ms (optional)
-pool_name : str - pool name (optional)
-```
-At least one parameter is required.
+Get an array of unspent outputs for one or more base58check or hash160 addresses. Returns an array of `UnspentOutput` objects.
+
+##### Params:
+* `str[] address_array`
+* `int limit` (optional) - the number of transactions to limit the response to (max. 1000, default 250)
+* `int confirmations` (optional) - minimum number of confirmations to show (default 0)
 
-Usage:
+##### Usage:
 ```ruby
-blocks = Blockchain::get_blocks(pool_name = 'Discus Fish')
+explorer.get_unspent_outputs(['1HS9RLmKvJ7D1ZYgfPExJZQZA1DMU3DEVd'])
 ```
 
-####`get_inventory_data`
-Get inventory data for recent blocks and addresses (up to 1 hour old). Returns an `InventoryData` object.
+### `get_latest_block`
+Get the latest block on the main chain. Returns a `LatestBlock` object.
 
-Params:
+##### Usage:
+```ruby
+explorer.get_latest_block()
 ```
-hash : str - tx or block hash
+
+### `get_unconfirmed_tx`
+Get the last 10 unconfirmed transactions. Returns an array of `Transaction` objects.
+
+##### Usage:
+```ruby
+explorer.get_unconfirmed_tx()
 ```
 
-Usage:
+### `get_blocks`
+Get a list of blocks for a specific day or mining pool. Returns an array of `SimpleBlock` objects.
+
+##### Params:
+* `int time` (optional) - unix time in ms
+* `str pool_name` (optional) - pool name
+
+Providing neither parameter will return all blocks mined today.
+
+##### Usage:
 ```ruby
-inv = Blockchain::get_inventory_data('d4af240386cdacab4ca666d178afc88280b620ae308ae8d2585e9ab8fc664a94')
+blocks = explorer.get_blocks(pool_name = 'Discus Fish')
 ```
 
 Note regarding `Input` objects: if coinbase transaction, only `script` and `script_siq` will be populated.
 
+## Response Object Properties
+
+A description of the objects returned by the methods in this class
+
+### SimpleBlock Object
+* `height`
+* `hash`
+* `time`
+* `main_chain`
+
+### LatestBlock Object
+* `hash`
+* `time`
+* `block_index`
+* `height`
+* `tx_indexes`
+
+### UnspentOutput Object
+* `tx_hash`
+* `tx_index`
+* `tx_output_n`
+* `script`
+* `value`
+* `value_hex`
+* `confirmations`
+
+### Address Object
+* `hash160`
+* `address`
+* `n_tx`
+* `total_received`
+* `total_sent`
+* `final_balance`
+* `transactions`
+
+### MultiAddress Object
+* `addresses`
+* `transactions`
+
+### Xpub Object
+* `address`
+* `n_tx`
+* `total_received`
+* `total_sent`
+* `final_balance`
+* `change_index`
+* `account_index`
+* `gap_limit`
+
+### Input Object
+* `n`
+* `value`
+* `address`
+* `tx_index`
+* `type`
+* `script`
+* `script_sig`
+* `sequence`
+
+### Output Object
+* `n`
+* `value`
+* `address`
+* `tx_index`
+* `script`
+* `spent`
+
+### Transaction Object
+* `double_spend`
+* `block_height`
+* `time`
+* `relayed_by`
+* `hash`
+* `tx_index`
+* `version`
+* `size`
+* `inputs`
+* `outputs`
+
+### Block Object
+* `hash`
+* `version`
+* `previous_block`
+* `merkle_root`
+* `time`
+* `bits`
+* `fee`
+* `nonce`
+* `n_tx`
+* `size`
+* `block_index`
+* `main_chain`
+* `height`
+* `received_time`
+* `relayed_by`
+* `transactions`
+
+### FilterType Enum
+* `ALL`
+* `CONFIRMED_ONLY`
+* `REMOVE_UNSPENDABLE`

data/docs/createwallet.md

@@ -1,21 +1,38 @@
-##Create Wallet functionality
+# Create Wallet functionality
 
-####`create_wallet`
-Create a new Blockchain.info wallet. It can be created containing a pre-generated private key or will otherwise generate a new private key. Returns a `CreateWalletResponse` instance.
+Initialize an instance of the `WalletCreator` class:
 
-Params: 
-```
-password : str - password for the new wallet. At least 10 characters.
-api_code : str - API code with the create wallets permission
-url : str - URL for an instance of service-my-wallet
-priv : str - private key to add to the wallet (optional, keyword)
-label : str - label for the first address in the wallet (optional, keyword)
-email : str - email to associate with the new wallet (optional, keyword)
+```ruby
+require 'Blockchain'
+
+# create an instance potining to http://127,0.0.1:3000/
+wallet_creator = Blockchain::WalletCreator.new(api_code = 'your-api-code')
+
+# create an instance pointing to an alternative base url
+wallet_creator = Blockchain::BlockExplorer.new('http://some-alternative-url', 'your-api-code')
 ```
 
-Usage:
-```ruby
-require 'blockchain'
+## Methods
+
+### `create_wallet`
+Create a new Blockchain.info wallet. It can be created containing a pre-generated private key or will otherwise generate a new private key. Returns a `CreateWalletResponse` instance.
+
+##### Params:
+
+* `str password` - password for the new wallet. Min. 10 characters.
+* `str priv` (optional) - private key to add to the wallet.
+* `str label` (optional) - label for the first address in the wallet.
+* `str email` (optional) - email to associate with the new wallet.
+
 
-wallet = Blockchain::create_wallet('1234password', '58ck39ajuiw', 'http://localhost:3000/', label: 'Test wallet')
+##### Usage:
+```ruby
+new_wallet = wallet_creator.create_wallet('1234password', label = 'Test wallet')
 ```
+
+## Response Object Properties
+
+### CreateWalletResponse Object
+* `identifier`
+* `address`
+* `label`