yolodice-client 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b770b33186e05e3fd16caee8bdb990aca0da7740
-  data.tar.gz: c60e4b8ac43202cb52b3f33deac511cebf0cbc71
+  metadata.gz: 4777876d939b40f70b4bdba8a119d73afacdf1a9
+  data.tar.gz: d20844e3e1163eeb47d26a1ec4971732b5043877
 SHA512:
-  metadata.gz: 873a5a2542fa8da4ef04da2ba049b934117b7bb18eee723a39dae9fe4b45def756da1f58e462a1d6c9cbd2a5383ef3ffb99a4adc2c3c617e30577086ed861505
-  data.tar.gz: a7a8f91141abfc76fd481fb705fdba2541e5d1d3c9b7aa371b83e917207d857c570583ecce9ff438cad82d9196f0fd73f63cf8f4eae57e5ba3b1cc93ba8bd13f
+  metadata.gz: 638e0e46a0a2f8d128a7b0e2468370fb2940d236f15dee52e5ab1e80962d01925db278628815d5821311b6833a0fca46adaf6412f6c6bd10b04d8916f989f8b2
+  data.tar.gz: a2751949033cc6edcfca2440f1d52d43ce5015eb831a8a588c662e5e723eeb4b3be50d606d1812a1fbe582e154d1604ddfe291d88b5c59b85808ad52081655ab

data/README.md

@@ -32,15 +32,15 @@ YOLOdice API requires authentication for most of it's methods. A Bitcoin key/add
 
 1. Generate an Bitcoin public and private key:
 
-
+    ```ruby
     require 'bitcoin'
 
     btc_key = Bitcoin::Key.generate
     auth_key = btc_key.to_base58  # this is your secret code, store it in a secure place
     auth_addr = btc_key.addr      # paste this in your YD settings as a new key
+    ```
 
 2. Go to [YOLOdice account Settings](https://yolodice.com/#settings), create a new key and paste the `auth_addr` generated above. Set permissions as you wish.
-
 3. Use `auth_key` in your code to authenticate.
 
 Just a quick note — this address is used ONLY to authenticate. No coins will be ever sent to it.
@@ -48,9 +48,11 @@ Just a quick note — this address is used ONLY to authenticate. No coins wi
 
 ## Connecting
 
-    yd = YolodiceClient.new
-    yd.connect
-    yd.authenticate auth_key
+```ruby
+yd = YolodiceClient.new
+yd.connect
+yd.authenticate auth_key
+```
 
 It's important to authenticate immediately after connecting. Otherwise the connection will be closed by the server.
 
@@ -61,13 +63,15 @@ The client automatically sends a `ping` requests to the server every 30 seconds
 
 To preview the actuall messages sent back and forth you could provide your own logger object and set log level to `DEBUG` like this:
 
-    yd = YolodiceClient.new
-    logger = Logger.new STDERR
-    logger.level = Logger::DEBUG
-    yd.logger = logger
+```ruby
+yd = YolodiceClient.new
+logger = Logger.new STDERR
+logger.level = Logger::DEBUG
+yd.logger = logger
 
-    yd.connect
-    yd.authenticate auth_key
+yd.connect
+yd.authenticate auth_key
+```
 
 This would result in the output similar to this:
 
@@ -97,22 +101,69 @@ There are two error classes:
 
 `RemoteError` has two extra attributes: `code` and `data` that are mapped to values in the error object returned from the server.
 
+## Helper methods
+
+#### .satoshi_to_btc(v)
+
+Converts an amount value from satoshis (integer) to bitcoin (float).
+
+```ruby
+YolodiceClient.satoshi_to_btc(10_000)
+# => 0.0001
+```
+
+#### .btc_to_satoshi(v)
+
+Converts an amount value from bitcoin (float) to satoshi (integer).
+
+```ruby
+YolodiceClient.btc_to_satoshi(0.12312312)
+# => 12312312
+```
+
+#### .target_from_multiplier(m)
+
+It calculates target value given the multiplier for the bet. If you want to find our the target that corresponds e.g. to multiplier `4`, try this:
+
+```ruby
+target = YolodiceClient.target_from_multiplier(4)
+# => 247500
+```
+
+You can then use the target as an attribute to API method `create_bet`.
+
+#### .target_from_probability(p)
+
+It calculates target value given the win probability. Note: probability is a value ranged from 0 (0%) to 1 (100%). To find target that corresponds to win probability of 50% do this:
+
+```ruby
+target = YolodiceClient.target_from_probability(0.5)
+# => 500000
+```
+
+
 ## An example
 
 Here is a script that connects to the server, authenticates, fetches user data, rolls a few 50% chance bets and reads user data again (make sure to use your own credential):
 
-    require 'yolodice_client'
-    require 'pp'
-
-    auth_key = 'cPFVHENWNjs5UKNXXynDSWiRkBEph8hcrjHKkXK5SW9QHxx7i4jC'
-    yd = YolodiceClient.new
-    yd.connect
-    user = yd.authenticate auth_key
-    user_data = yd.read_user_data selector: {id: user['id']}
-    puts "Your account balance is: #{user_data['balance']} satoshis."
-    10.times do
-      b = yd.create_bet attrs: {amount: 100, range: 'lo', target: 500000}
-      puts "Bet profit: #{b['profit']}"
-    end
-    user_data = yd.read_user_data selector: {id: user['id']}
-    puts "Your account balance is: #{user_data['balance']} satoshis."
+```ruby
+require 'yolodice_client'
+require 'pp'
+
+auth_key = 'cPFVHENWNjs5UKNXXynDSWiRkBEph8hcrjHKkXK5SW9QHxx7i4jC'
+yd = YolodiceClient.new
+yd.connect
+user = yd.authenticate auth_key
+user_data = yd.read_user_data selector: {id: user['id']}
+puts "Your account balance is: #{user_data['balance']} satoshis."
+10.times do
+  b = yd.create_bet attrs: {amount: 100, range: 'lo', target: 500000}
+  puts "Bet profit: #{b['profit']}"
+end
+user_data = yd.read_user_data selector: {id: user['id']}
+puts "Your account balance is: #{user_data['balance']} satoshis."
+```
+
+# Even more examples
+
+We have created a new Github repository with Ruby script examples to get you started. If you are looking for inspiration, check this out: https://github.com/ethan-nx/yolodice-examples.

data/lib/yolodice_client.rb

@@ -62,28 +62,33 @@ class YolodiceClient
     @listening_thread = Thread.new do
       log.debug 'Listening thread started'
       loop do
-        msg = @connection.gets
-        log.debug{ "<<< #{msg}" }
-        message = JSON.parse msg
-        if message['id'] && (message.has_key?('result') || message.has_key?('error'))
-          # definitealy a response
-          callback = @thread_semaphore.synchronize{ @current_requests.delete message['id'] }
-          raise Error, "Unknown id in response" unless callback
-          if callback.is_a? Integer
-            # it's a thread
-            @receive_queues[callback] << message
-          elsif callback.is_a? Proc
-            # A thread pool would be better.
-            Thread.new do
-              callback.call message
+        begin
+          msg = @connection.gets
+          next if msg == nil
+          log.debug{ "<<< #{msg}" }
+          message = JSON.parse msg
+          if message['id'] && (message.has_key?('result') || message.has_key?('error'))
+            # definitealy a response
+            callback = @thread_semaphore.synchronize{ @current_requests.delete message['id'] }
+            raise Error, "Unknown id in response" unless callback
+            if callback.is_a? Integer
+              # it's a thread
+              @receive_queues[callback] << message
+            elsif callback.is_a? Proc
+              # A thread pool would be better.
+              Thread.new do
+                callback.call message
+              end
             end
-          end
-        else
-          if message['id']
-            # It must be a request from the server. We do not support it yet.
           else
-            # No id, it must be a notification then. This can be implemented later.
+            if message['id']
+              # It must be a request from the server. We do not support it yet.
+            else
+              # No id, it must be a notification then. This can be implemented later.
+            end
           end
+        rescue StandardError => e
+          log.error e
         end
       end
     end
@@ -91,8 +96,12 @@ class YolodiceClient
     @pinging_thread = Thread.new do
       log.debug 'Pinging thread started'
       loop do
-        sleep 30
-        call :ping
+        begin
+          sleep 30
+          call :ping
+        rescue StandardError => e
+          log.error e
+        end
       end
     end
     true
@@ -165,6 +174,7 @@ class YolodiceClient
       # a regular blocking request
       @thread_semaphore.synchronize{ @current_requests[id] = Thread.current.object_id }
       queue = (@receive_queues[Thread.current.object_id] ||= Queue.new)
+      queue.clear
       log.debug{ "Calling remote method #{method}(#{params.inspect if params != nil})" }
       log.debug{ ">>> #{request.to_json}" }
       @connection.puts request.to_json
@@ -213,8 +223,42 @@ class YolodiceClient
     def initialize(error_obj = {'code' => -1, 'message' => "RPC Error"})
       @code = error_obj['code'] || -1
       @data = error_obj['data'] if error_obj['data']
-      super "#{@code}: #{error_obj['message']}"
+      msg = "#{@code}: #{error_obj['message']}"
+      if @code == 422 && @data && @data.has_key?('errors')
+        msg += ': ' + @data['errors'].to_json
+      end
+      super msg
     end
   end
 
+  class << self
+
+    ##
+    # Returns bet terget given the required multiplier.
+
+    def target_from_multiplier m
+      edge = 0.01
+      (1_000_000.0 * (1.0 - edge) / m).round
+    end
+
+    ##
+    # Returns bet target given the required win probability.
+
+    def target_from_probability p
+      (p * 1_000_000.0).round
+    end
+
+    ##
+    # Converts amount from satoshi (integer) to amount in bitcoins (float).
+
+    def satoshi_to_btc v
+      (v.to_f / 100_000_000).round(8)
+    end
+
+    ## Converts amount from bitcoins (float) to satoshi (integer).
+    def btc_to_satoshi v
+      (v * 100_000_000).round
+    end
+
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yolodice-client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - ethan_nx
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-10 00:00:00.000000000 Z
+date: 2017-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bitcoin-ruby