queru_btce 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6351e5152b137d19c1f110ba8c86c5936dc398d
-  data.tar.gz: e9a7bf1bf72f1af77864d93590c75cdfb5f8b063
+  metadata.gz: 30d380d0fc4144ce3594a6947f081ffbf6d8602c
+  data.tar.gz: 3131b493f07858ab249f349f8095a54634699956
 SHA512:
-  metadata.gz: 0fcf1de5dc9ddf6173bc24e674ff709d9ec87fe95afe06186cd5941f257521797a5c1081dceab43499e0bef11bd6d2adb52e184a360b16ecf92be2e77155d70e
-  data.tar.gz: 6b0fa3549bf8b9935bbb03825c1c7efa1fb6ef5c82f9d502e4900e6e07133f38723d5500c57dd787c3dfb8b1e51f9c41ef9819190735df9a81e9c21eaddf7522
+  metadata.gz: f424c4e7ade55b4f7cd3d5d8499e45b56b8c740879f3df70b98a22b1271ef0d1ab919bdecad874b86cad5e4bc97052a61ba1529ed8dc52f2c4df9eaaa2dbf071
+  data.tar.gz: b30b30a6547db00751788c07ddb622a34926b1a18c2a58f00e04e3ebca2329823edf7acc4dc73f896372fb0cc3f9353a6647b2bcfb3ea7aefebc0f2aeeff8b4b

data/README.md

@@ -1,11 +1,11 @@
 # queru-btce
 
-KISS BTC-E API Access from Ruby.
+KISS _BTC-e_ API Access from Ruby.
 
 ### Pros:
 
 - No config file and no framework dependency.
-- No weird abstractions, you can follow BTC-e API specs.
+- No weird abstractions, you can follow _BTC-e_ API specs.
 - Returns an object, keys are methods.
 - Really few error abstraction, exceptions are raised.
 - Nounce is enforced, I don't expect damm nounce error.
@@ -13,7 +13,7 @@ KISS BTC-E API Access from Ruby.
 
 ### Cons:
 
-- Not much abstraction, you should know BTC-e API.
+- Not much abstraction, you should know _BTC-e_ API.
 - Its in **BETA** status. Not production tested until now.
 
 ## Installation
@@ -38,22 +38,82 @@ $ gem install queru-btce
 
 ## Usage
 
-This gem provides class methods for all public/private API methods offered by BTC-e.
+This gem provides class methods for all public/private API methods offered by _BTC-e_.
 Responses are hashes and any errors are raised as exception, your program can handle it.
 
-- [BTC-E Trade API Documentation](https://btc-e.com/api/documentation)
-- [BTC-E Public API Documentation](https://btc-e.com/api/3/docs)
+- [_BTC-e_ Trade API Documentation](https://btc-e.com/api/documentation)
+- [_BTC-e_ Public API Documentation](https://btc-e.com/api/3/docs)
 
-You can call any BTC-e API methods this way:
+You can call any _BTC-e_ API method this way:
 
+#### Public API example:
 ```ruby
-QueruBtce.info
-QueruBtce.ticker(:btc_usd)
+info = QueruBtce.info
+puts info.server_time
+
+btc_usd = QueruBtce.ticker(:btc_usd)
+puts btc_usd.ask
+puts btc_usd.bid
+
 QueruBtce.ticker(:btc_usd).btc_usd.last
-QueruBtce.ticker(:btc_usd, :eth_usd).eth_usd.ask
+mytickers = QueruBtce.ticker(:btc_usd, :eth_usd, :ltc_usd)
+puts "BTC: #{mytickers.btc_usd.last}"
+puts "ETH: #{mytickers.eth_usd.last}"
+puts "LTC: #{mytickers.ltc_usd.last}"
+```
+
+#### Public API methods:
+
+All the described at _BTC-e_ documentation:
+
+```ruby
+QueruBtce.info
+QueruBtce.ticker
+QueruBtce.depth
+QueruBtce.trades
+```
+
+#### Private API:
+```ruby
+QueruBtce.credentials key: 'mykey', secret: 'mysecret'
+my_info = QueruBtce.get_info
+puts my_info.return.funds.btc
+
+orders = QueruBtce.active_orders pair: :btc_usd
+puts 'I have open orders' if orders.return
+```
+
+#### Trade API methods:
+
+
+All the described at _BTC-e_ documentation. Parameters are passed as hash, for example:
+
+```ruby
+QueruBtce.trans_history from: 0, count: 100, order: 'ASC'
+```
+
+The list is:
+
+```ruby
+QueruBtce.get_info
+QueruBtce.trans_history
+QueruBtce.trade_history
+QueruBtce.active_orders
+QueruBtce.trade
+QueruBtce.cancel_order
 ```
 
-More docs to come.
+## Tips:
+
+### Nounce error:
+
+Nonce is param required by _BTC-e_ trade api, is just an integer but the current one should be greater than the last one. I guess they require it to ensure your transactions are received in a known order, sequentially.
+
+This gem always send a timestamp as nounce, ensuring its greater than the last one, so calls are delayed a second between. Not a problem cause API can dump you if you try to ask faster.
+
+But if you are calling the API from more than one process, there's no locking mechanism in gem (maybe in the future) and you need to implement a lock to prevent making two calls at once. A cache key, or distributed message can do the work, even a semaphore file locking.
+
+It remains at your side by the moment.
 
 ## Contributing
 

data/lib/queru_btce/version.rb

@@ -1,3 +1,3 @@
 module QueruBtce
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.0.2'.freeze
 end

data/queru_btce.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.3'
+
   spec.add_dependency 'json', '~> 2.1'
   spec.add_dependency 'rubysl-ostruct', '~> 2.1'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: queru_btce
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Queru AKA Jorge Fuertes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-14 00:00:00.000000000 Z
+date: 2017-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -124,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: KISS BTC-e API Access from Ruby