bitflyer 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f49b4a666d8df93717c072384a5be911359f9374c323e06ed7ee50cc3780b22
-  data.tar.gz: 719a1bc27381f6cf81a560050f306b7adc5946e36ddbd30da2f60686e34af652
+  metadata.gz: 0afb7c55d8bf1c0c68fdb043881e446ad9481b932a328c25cc68dadabbd935c4
+  data.tar.gz: 0d58c2aebb84b56f15bcc4bca7da2a2ace9f8c39ec6a6b87fa9460d03087d61f
 SHA512:
-  metadata.gz: eb08f088aea6b006cef2f8b29c8d52c908653386909524cb3aed4057e1cba6f1a7992bc713b6726abb36c0f8a98d8581e13b712c6b665e69eda8565bb957bebc
-  data.tar.gz: 63a9357c4f45bd9f77604e9393d32c852daf682c6da54c8552b1eea4c3be22ab89b7abe9392f784e3cf6099e07a77b286f7583620ed008b8e44d405996fd3925
+  metadata.gz: af27099352002ac7983bb1655c6f7d04e606fa06494d76e37943c1c1343c4d6fdf987d235d36a863e63365e667ff7a61a7564fa81800f8ef6f9798b362c6df76
+  data.tar.gz: 6e5f176afd23d3c438a1a5ec679a9e5dbd0b1a30784ce91968ce29f2914d7cd5dcd3eec1b5a96e260a203aef4375c4a90b31b2a77b2fb78c3e6fdfe28ec70a19

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bitflyer (1.1.0)
+    bitflyer (1.2.0)
       faraday (>= 0.14, < 1.4)
       faraday_middleware (>= 0.12, < 1.1)
       websocket-client-simple (~> 0.3.0)
@@ -30,7 +30,7 @@ GEM
       method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.0.3)
+    regexp_parser (2.1.1)
     rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -45,7 +45,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.10.0)
+    rubocop (1.11.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)

data/README.md

@@ -37,20 +37,52 @@ p private_client.positions # will print your positions
 
 ### Realtime API
 
+#### Public events
+
 Accessor format is like `{event_name}_{product_code}`.
 You can set lambda to get realtime events.
 
 `{event_name}` and `{product_code}` is defined at [client.rb](./lib/bitflyer/realtime/client.rb).
 
-#### Example
+#### Private events
+
+To subscribe to the private `child_order_events` and `parent_order_events`, pass your API key and secret when creating the `realtime_client`.
+
+#### Connection status monitoring
 
+The `ready` callback is called when the `realtime_client` is ready to receive events (after the socket connection is established, the optional authentication has succeeded, and the channels have been subscribed). If connection is lost, the `disconnected` callback is called, and reconnection is attempted automatically. When connection is restored, `ready` is called again.
+
+#### Examples
+
+For public events only:
 ```ruby
 client = Bitflyer.realtime_client
-client.ticker_btc_jpy = ->(json){ p json } # will print json object 
+client.ticker_btc_jpy = ->(json){ p json } # will print json object
+client.executions_btc_jpy = ->(json){ p json }
+# ...
+```
+
+For both public and private events:
+```ruby
+client = Bitflyer.realtime_client('YOUR_API_KEY', 'YOUR_API_SECRET')
+# Private events:
+client.child_order_events = ->(json){ p json }
+client.parent_order_events = ->(json){ p json }
+# Public events:
+client.ticker_btc_jpy = ->(json){ p json }
 client.executions_btc_jpy = ->(json){ p json }
-# ... 
+# ...
+```
+
+Connection monitoring:
+```ruby
+client = Bitflyer.realtime_client
+client.ready = -> { p "Client is ready to receive events" }
+client.disconnected = ->(error) { p "Client got disconnected" }
 ```
 
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/unhappychoice/bitflyer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -80,4 +112,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

data/lib/bitflyer.rb

@@ -5,8 +5,8 @@ require 'bitflyer/http'
 require 'bitflyer/realtime'
 
 module Bitflyer
-  def realtime_client
-    Bitflyer::Realtime::Client.new
+  def realtime_client(key = nil, secret = nil)
+    Bitflyer::Realtime::Client.new(key, secret)
   end
 
   def http_public_client

data/lib/bitflyer/realtime/client.rb

@@ -4,13 +4,17 @@ require_relative './websocket'
 
 module Bitflyer
   module Realtime
-    EVENT_NAMES = %w[lightning_board_snapshot lightning_board lightning_ticker lightning_executions].freeze
+    PUBLIC_EVENT_NAMES = %w[lightning_board_snapshot lightning_board lightning_ticker lightning_executions].freeze
     MARKETS = %w[BTC_JPY FX_BTC_JPY ETH_BTC BCH_BTC BTCJPY_MAT3M BTCJPY_MAT1WK BTCJPY_MAT2WK].freeze
-    CHANNEL_NAMES = EVENT_NAMES.product(MARKETS).map { |e, m| "#{e}_#{m}" }
+    PUBLIC_CHANNEL_NAMES = PUBLIC_EVENT_NAMES.product(MARKETS).map { |e, m| "#{e}_#{m}" }.freeze
+    PRIVATE_CHANNEL_NAMES = %w[child_order_events parent_order_events].freeze
+    CHANNEL_NAMES = (PUBLIC_CHANNEL_NAMES + PRIVATE_CHANNEL_NAMES).freeze
 
     SOCKET_HOST = 'https://io.lightstream.bitflyer.com'
 
     class Client
+      extend Forwardable
+      def_delegators :@websocket_client, :ready=, :disconnected=
       attr_accessor :websocket_client, :ping_interval, :ping_timeout, :last_ping_at, :last_pong_at
 
       Realtime::CHANNEL_NAMES.each do |channel_name|
@@ -19,8 +23,8 @@ module Bitflyer
         end
       end
 
-      def initialize
-        @websocket_client = Bitflyer::Realtime::WebSocketClient.new(host: SOCKET_HOST)
+      def initialize(key = nil, secret = nil)
+        @websocket_client = Bitflyer::Realtime::WebSocketClient.new(host: SOCKET_HOST, key: key, secret: secret)
       end
     end
   end

data/lib/bitflyer/realtime/websocket.rb

@@ -2,54 +2,55 @@
 
 require 'websocket-client-simple'
 require 'json'
+require 'openssl'
 
 module Bitflyer
   module Realtime
     class WebSocketClient
-      attr_accessor :websocket_client, :channel_name, :channel_callbacks, :ping_interval, :ping_timeout,
-                    :last_ping_at, :last_pong_at, :error
+      attr_accessor :websocket_client, :channel_names, :channel_callbacks, :ping_interval, :ping_timeout,
+                    :last_ping_at, :last_pong_at, :ready, :disconnected
 
-      def initialize(host:, debug: false)
+      def initialize(host:, key:, secret:, debug: false)
         @host = host
+        @key = key
+        @secret = secret
         @debug = debug
-        @error = nil
         @channel_names = []
         @channel_callbacks = {}
         connect
+        start_monitoring
       end
 
       def subscribe(channel_name:, &block)
         debug_log "Subscribe #{channel_name}"
         @channel_names = (@channel_names + [channel_name]).uniq
         @channel_callbacks[channel_name] = block
-        websocket_client.send "42#{['subscribe', channel_name].to_json}"
+        @websocket_client.send "42#{['subscribe', channel_name].to_json}"
       end
 
       def connect
         @websocket_client = WebSocket::Client::Simple.connect "#{@host}/socket.io/?transport=websocket"
         this = self
+        @websocket_client.on(:message) { |payload| this.handle_message(payload: payload) }
+        @websocket_client.on(:error) { |error| this.handle_error(error: error) }
+        @websocket_client.on(:close) { |error| this.handle_close(error: error) }
+      rescue SocketError => e
+        puts e
+        puts e.backtrace.join("\n")
+      end
 
+      def start_monitoring
         Thread.new do
           loop do
             sleep 1
             if @websocket_client&.open?
               send_ping
               wait_pong
+            else
+              reconnect
             end
           end
         end
-
-        Thread.new do
-          loop do
-            sleep 1
-            next unless @error
-
-            reconnect
-          end
-        end
-
-        @websocket_client.on(:message) { |payload| this.handle_message(payload: payload) }
-        @websocket_client.on(:error) { |error| this.handle_error(error: error) }
       end
 
       def send_ping
@@ -70,23 +71,19 @@ module Bitflyer
       end
 
       def reconnect
-        return unless @error
+        return if @websocket_client&.open?
 
         debug_log 'Reconnecting...'
 
-        @error = nil
         @websocket_client.close if @websocket_client.open?
         connect
-        @channel_names.each do |channel_name|
-          debug_log "42#{{ subscribe: channel_name }.to_json}"
-          websocket_client.send "42#{['subscribe', channel_name].to_json}"
-        end
       end
 
       def handle_error(error:)
         debug_log error
         return unless error.is_a? Errno::ECONNRESET
 
+        @disconnected&.call(error)
         reconnect
       end
 
@@ -101,20 +98,60 @@ module Bitflyer
         when 3 then receive_pong
         when 41 then disconnect
         when 42 then emit_message(json: body)
+        when 430 then authenticated(json: body)
         end
       rescue StandardError => e
         puts e
         puts e.backtrace.join("\n")
       end
 
+      def handle_close(error:)
+        debug_log error
+        @disconnected&.call(error)
+      end
+
       def setup_by_response(json:)
         body = JSON.parse json
         @ping_interval = body['pingInterval'].to_i || 25_000
         @ping_timeout  = body['pingTimeout'].to_i || 60_000
         @last_ping_at = Time.now.to_i
         @last_pong_at = Time.now.to_i
-        channel_callbacks.each do |channel_name, _|
-          websocket_client.send "42#{['subscribe', channel_name].to_json}"
+        if @key && @secret
+          authenticate
+        else
+          subscribe_channels
+          @ready&.call
+        end
+      end
+
+      def authenticate
+        debug_log 'Authenticate'
+        timestamp = Time.now.to_i
+        nonce = Random.new.bytes(16).unpack('H*').first
+        signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), @secret, timestamp.to_s + nonce)
+        auth_params = {
+          api_key: @key,
+          timestamp: timestamp,
+          nonce: nonce,
+          signature: signature
+        }
+        @websocket_client.send "420#{['auth', auth_params].to_json}"
+      end
+
+      def authenticated(json:)
+        if json == '[null]'
+          debug_log 'Authenticated'
+          subscribe_channels
+          @ready&.call
+        else
+          raise "Authentication failed: #{json}"
+        end
+      end
+
+      def subscribe_channels
+        @channel_callbacks.each do |channel_name, _|
+          debug_log "42#{{ subscribe: channel_name }.to_json}"
+          @websocket_client.send "42#{['subscribe', channel_name].to_json}"
         end
       end
 
@@ -125,7 +162,7 @@ module Bitflyer
 
       def disconnect
         debug_log 'Disconnecting from server...'
-        @error = true
+        @websocket_client.close
       end
 
       def emit_message(json:)

data/lib/bitflyer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bitflyer
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitflyer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Yuji Ueki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday