blockchain 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9632fa2321d9fd2c31b83a92805d0e4b5c3adb8c
-  data.tar.gz: 815a5905bfe359dd078674515e0e5e23c6047785
+  metadata.gz: e743573eea586a756a9be86dd0520a3ef75731ac
+  data.tar.gz: b0e4df9dcaadddbd4ea608ad52a7e7488ddb4372
 SHA512:
-  metadata.gz: c4950484bf456cf3ea3b5924a39faab96d6788a660ca28cbe9e8c0e0fff63a1b62606a3e775eb928a68184d995b4135654ed1638d2b594be1e3c04d0b55d1fb0
-  data.tar.gz: 57369609fe4381631733b42d482319a2b3927e8d71a9498104424d5f9bd06f8e64c61251575fcbd77aff7cdf0016d3c091da0d0937cbcae422331d8e5374accd
+  metadata.gz: 776d8f47c6ab6880fc3597990d034f433b0a54075585cd936f8b068a98c9b48407fd14021a8108784dd75ca064efcb9d276af7684f8e1cdfb647e0fa72ab3c6d
+  data.tar.gz: 5b4ef222ccaabc04bdc9cbcd227b32ff1b3a1f5dcd684e7775cb30ee448b597c68f1d76302d1d549c5eb6003d76808b1298576429f6276e892708cd5dab2dc86

data/README.md

@@ -1,57 +1,57 @@
-#Blockchain API library (Ruby, v1)
-
-An official Ruby gem for interacting with the Blockchain.info API.
-
-###Getting started
-
-Installation via RubyGems:
-
-```
-$ gem install blockchain
-```
-
-Manual installation:
-```
-$ git clone https://github.com/blockchain/api-v1-client-ruby
-$ cd api-v1-client-ruby
-$ rake install
-```
-
-The gem consists of the following functionality:
-
-* `blockexplorer` ([docs](docs/blockexplorer.md)) ([api/blockchain_api][api1])
-* `createwallet` ([docs](docs/createwallet.md)) ([api/create_wallet][api2])
-* `exchangerates` ([docs](docs/exchangerates.md)) ([api/exchange\_rates\_api][api3])
-* `pushtx` ([docs](docs/pushtx.md)) ([pushtx][api7])
-* `receive` ([docs](docs/receive.md)) ([api/api_receive][api4])
-* `statistics` ([docs](docs/statistics.md)) ([api/charts_api][api5])
-* `wallet` ([docs](docs/wallet.md)) ([api/blockchain\_wallet\_api][api6])
-
-The main module is called `Blockchain`
-
-###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
-
-It is possible to set arbitrary connection timeouts.
-
-```ruby
-require 'blockchain'
-Blockchain::TIMEOUT_SECONDS = 5 #time out after 5 seconds
-```
-
-###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).
-
-The same API key can be used to bypass the request limiter.
-
-[api1]: https://blockchain.info/api/blockchain_api
-[api2]: https://blockchain.info/api/create_wallet
-[api3]: https://blockchain.info/api/exchange_rates_api
-[api4]: https://blockchain.info/api/api_receive
-[api5]: https://blockchain.info/api/charts_api
-[api6]: https://blockchain.info/api/blockchain_wallet_api
-[api7]: https://blockchain.info/pushtx
+#Blockchain API library (Ruby, v1)
+
+An official Ruby gem for interacting with the Blockchain.info API.
+
+###Getting started
+
+Installation via RubyGems:
+
+```
+$ gem install blockchain
+```
+
+Manual installation:
+```
+$ git clone https://github.com/blockchain/api-v1-client-ruby
+$ cd api-v1-client-ruby
+$ rake install
+```
+
+The gem consists of the following functionality:
+
+* `blockexplorer` ([docs](docs/blockexplorer.md)) ([api/blockchain_api][api1])
+* `createwallet` ([docs](docs/createwallet.md)) ([api/create_wallet][api2])
+* `exchangerates` ([docs](docs/exchangerates.md)) ([api/exchange\_rates\_api][api3])
+* `pushtx` ([docs](docs/pushtx.md)) ([pushtx][api7])
+* `receive` ([docs](docs/receive.md)) ([api/api_receive][api4])
+* `statistics` ([docs](docs/statistics.md)) ([api/charts_api][api5])
+* `wallet` ([docs](docs/wallet.md)) ([api/blockchain\_wallet\_api][api6])
+
+The main module is called `Blockchain`
+
+###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
+
+It is possible to set arbitrary connection timeouts.
+
+```ruby
+require 'blockchain'
+Blockchain::TIMEOUT_SECONDS = 5 #time out after 5 seconds
+```
+
+###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).
+
+The same API key can be used to bypass the request limiter.
+
+[api1]: https://blockchain.info/api/blockchain_api
+[api2]: https://blockchain.info/api/create_wallet
+[api3]: https://blockchain.info/api/exchange_rates_api
+[api4]: https://blockchain.info/api/api_receive
+[api5]: https://blockchain.info/api/charts_api
+[api6]: https://blockchain.info/api/blockchain_wallet_api
+[api7]: https://blockchain.info/pushtx

data/docs/blockexplorer.md

@@ -1,117 +1,117 @@
-##Block explorer functionality
-
-All functions support an optional parameter called `api_code`. It won't be listed with every function description.
-
-####`get_block`
-Get a single block based on a block index or hash. Returns a `Block` object.
-
-Params: 
-```
-block_id : str - block index or hash
-```
-
-Usage:
-```ruby
-require 'blockchain'
-
-block = Blockchain::get_block('000000000000000016f9a2c3e0f4c1245ff24856a79c34806969f5084f410680')
-```
-
-####`get_tx`
-Get a single transaction based on a transaction index or hash. Returns a `Transaction` object.
-
-Params:
-```
-tx_id : str - transaction index or hash
-```
-
-Usage:
-```ruby
-tx = Blockchain::get_tx('d4af240386cdacab4ca666d178afc88280b620ae308ae8d2585e9ab8fc664a94')
-```
-
-####`get_block_height`
-Get an array of blocks at the specified height. Returns an array of `Block` objects.
-
-Params:
-```
-height : int - block height
-```
-
-Usage:
-```ruby
-blocks = Blockchain::get_block_height(2570)
-```
-
-####`get_address`
-Get a single address and its transactions. Returns an `Address` object.
-
-Params:
-```
-address : str - address in the base58 or hash160 format
-```
-
-Usage:
-```ruby
-address = Blockchain::get_address('1HS9RLmKvJ7D1ZYgfPExJZQZA1DMU3DEVd')
-```
-
-####`get_unspent_outputs`
-Get an array of unspent outputs for an address. Returns an array of `UnspentOutput` objects.
-
-Params:
-```
-address : str - address in the base58 or hash160 format
-```
-
-Usage:
-```ruby
-outs = Blockchain::get_unspent_outputs('1HS9RLmKvJ7D1ZYgfPExJZQZA1DMU3DEVd')
-```
-
-####`get_latest_block`
-Get the latest block on the main chain. Returns a `LatestBlock` object.
-
-Usage:
-```ruby
-latest_block = Blockchain::get_latest_block()
-```
-
-####`get_unconfirmed_tx`
-Get a list of currently unconfirmed transactions. Returns an array of `Transaction` objects.
-
-Usage:
-```ruby
-txs = Blockchain::get_unconfirmed_tx()
-```
-
-####`get_blocks`
-Get a list of blocks for a specific day or mining pool. Returns an array of `SimpleBlock` objects.
-
-Params:
-```
-time : int - unix time in ms (optional)
-pool_name : str - pool name (optional)
-```
-At least one parameter is required.
-
-Usage:
-```ruby
-blocks = Blockchain::get_blocks(pool_name = 'Discus Fish')
-```
-
-####`get_inventory_data`
-Get inventory data for recent blocks and addresses (up to 1 hour old). Returns an `InventoryData` object.
-
-Params:
-```
-hash : str - tx or block hash
-```
-
-Usage:
-```ruby
-inv = Blockchain::get_inventory_data('d4af240386cdacab4ca666d178afc88280b620ae308ae8d2585e9ab8fc664a94')
-```
-
-Note regarding `Input` objects: if coinbase transaction, only `script` and `script_siq` will be populated.
-
+##Block explorer functionality
+
+All functions support an optional parameter called `api_code`. It won't be listed with every function description.
+
+####`get_block`
+Get a single block based on a block index or hash. Returns a `Block` object.
+
+Params: 
+```
+block_id : str - block index or hash
+```
+
+Usage:
+```ruby
+require 'blockchain'
+
+block = Blockchain::get_block('000000000000000016f9a2c3e0f4c1245ff24856a79c34806969f5084f410680')
+```
+
+####`get_tx`
+Get a single transaction based on a transaction index or hash. Returns a `Transaction` object.
+
+Params:
+```
+tx_id : str - transaction index or hash
+```
+
+Usage:
+```ruby
+tx = Blockchain::get_tx('d4af240386cdacab4ca666d178afc88280b620ae308ae8d2585e9ab8fc664a94')
+```
+
+####`get_block_height`
+Get an array of blocks at the specified height. Returns an array of `Block` objects.
+
+Params:
+```
+height : int - block height
+```
+
+Usage:
+```ruby
+blocks = Blockchain::get_block_height(2570)
+```
+
+####`get_address`
+Get a single address and its transactions. Returns an `Address` object.
+
+Params:
+```
+address : str - address in the base58 or hash160 format
+```
+
+Usage:
+```ruby
+address = Blockchain::get_address('1HS9RLmKvJ7D1ZYgfPExJZQZA1DMU3DEVd')
+```
+
+####`get_unspent_outputs`
+Get an array of unspent outputs for an address. Returns an array of `UnspentOutput` objects.
+
+Params:
+```
+address : str - address in the base58 or hash160 format
+```
+
+Usage:
+```ruby
+outs = Blockchain::get_unspent_outputs('1HS9RLmKvJ7D1ZYgfPExJZQZA1DMU3DEVd')
+```
+
+####`get_latest_block`
+Get the latest block on the main chain. Returns a `LatestBlock` object.
+
+Usage:
+```ruby
+latest_block = Blockchain::get_latest_block()
+```
+
+####`get_unconfirmed_tx`
+Get a list of currently unconfirmed transactions. Returns an array of `Transaction` objects.
+
+Usage:
+```ruby
+txs = Blockchain::get_unconfirmed_tx()
+```
+
+####`get_blocks`
+Get a list of blocks for a specific day or mining pool. Returns an array of `SimpleBlock` objects.
+
+Params:
+```
+time : int - unix time in ms (optional)
+pool_name : str - pool name (optional)
+```
+At least one parameter is required.
+
+Usage:
+```ruby
+blocks = Blockchain::get_blocks(pool_name = 'Discus Fish')
+```
+
+####`get_inventory_data`
+Get inventory data for recent blocks and addresses (up to 1 hour old). Returns an `InventoryData` object.
+
+Params:
+```
+hash : str - tx or block hash
+```
+
+Usage:
+```ruby
+inv = Blockchain::get_inventory_data('d4af240386cdacab4ca666d178afc88280b620ae308ae8d2585e9ab8fc664a94')
+```
+
+Note regarding `Input` objects: if coinbase transaction, only `script` and `script_siq` will be populated.
+

data/docs/createwallet.md

@@ -1,20 +1,20 @@
-##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.
-
-Params: 
-```
-password : str - password for the new wallet. At least 10 characters.
-api_code : str - API code with the create wallets permission
-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)
-```
-
-Usage:
-```ruby
-require 'blockchain'
-
-wallet = Blockchain::create_wallet('1234password', '58ck39ajuiw', label: 'Test wallet')
-```
+##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.
+
+Params: 
+```
+password : str - password for the new wallet. At least 10 characters.
+api_code : str - API code with the create wallets permission
+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)
+```
+
+Usage:
+```ruby
+require 'blockchain'
+
+wallet = Blockchain::create_wallet('1234password', '58ck39ajuiw', label: 'Test wallet')
+```

data/docs/exchangerates.md

@@ -1,32 +1,32 @@
-##Exchange rates functionality
-
-All functions support an optional parameter called `api_code`. It won't be listed with every function description.
-
-####`get_ticker`
-Call the 'ticker' method and return a dictionary of `Currency` objects. Keys are currency symbols (str) and values are `Currency` objects.
-
-
-Usage:
-```ruby
-require 'blockchain'
-
-ticker = Blockchain::get_ticker()
-#print the 15 min price for every currency
-ticker.keys.each do |key|
-	puts ticker[key].p15min
-end
-```
-
-####`to_btc`
-Call the 'tobtc' method and convert x value in the provided currency to BTC. Returns a `float`.
-
-Params:
-```
-ccy : str - currency code
-value : float
-```
-
-Usage:
-```ruby
-btc_amount = Blockchain::to_btc('USD', 4342.11)
+##Exchange rates functionality
+
+All functions support an optional parameter called `api_code`. It won't be listed with every function description.
+
+####`get_ticker`
+Call the 'ticker' method and return a dictionary of `Currency` objects. Keys are currency symbols (str) and values are `Currency` objects.
+
+
+Usage:
+```ruby
+require 'blockchain'
+
+ticker = Blockchain::get_ticker()
+#print the 15 min price for every currency
+ticker.keys.each do |key|
+	puts ticker[key].p15min
+end
+```
+
+####`to_btc`
+Call the 'tobtc' method and convert x value in the provided currency to BTC. Returns a `float`.
+
+Params:
+```
+ccy : str - currency code
+value : float
+```
+
+Usage:
+```ruby
+btc_amount = Blockchain::to_btc('USD', 4342.11)
 ```