stockfighter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 154ddcc262a23ff8b0405fc5e0ba6d786acbbfd3
-  data.tar.gz: 269848186df9487af20330d68c6c2a44c0fbcb05
+  metadata.gz: 885259cfcbbb561e9bfcc16d21394302b6615f82
+  data.tar.gz: c1e9ebf5573a7056adcd8a154562b0fa0d76d015
 SHA512:
-  metadata.gz: c013b1a77db9436e7a2d8524a3f92ee8fd10871d8af16e7128511958b6b1cce27a08cc64397a3e15adbadc8d6571cbcca6720c9a9d8047db0226fd39c9d16915
-  data.tar.gz: 2d6540bfd7b0e1c4d144745772326249e44e94c559df1ddee27c7c070f2e75b009f6ad06b2b3fb94dcb440605dc5869df51f20259fd88db091324302cb279582
+  metadata.gz: 0093757ab0fd12e8ae655809826e5424f943be049bd9bb146bd35373b6a94cf64e60d8e8ea0059c09a250acefa77f60e1501f05a23c756019ef31613dc705178
+  data.tar.gz: a79a9cb440da8136034f8f6d19787329def1c2fbbbe9aaf002e22efcdf9d320a90bfa3f771399d8ad3bd6fa6830faa2ec8060c9ea8d989cb454e2e42147474bd

data/README.md

@@ -18,17 +18,35 @@ Or install it yourself as:
 
     $ gem install stockfighter
 
+## Features
+
+This gem can be used as a simple API client for the trading API, but also
+includes more advanced features for interacting with the (officially undocumented)
+GM API. This includes the ability to start / stop / restart / resume levels,
+automatically fetch level info such as ticker, venue, and account, and also poll
+the GM server regularly and return level and game information.
+
+Support for the websockets API is also available
+
 ## Usage
 
+Coming soon: comprehensive overview and API overview! For now, take a look at
+some of the sample code below.
+
 ### Example
 ```ruby
 require 'stockfighter'
 
-# Use the GM to fetch the info automatically
+# Use the GM to fetch level info for the trading API automatically
+
+gm = Stockfighter::GM.new(key: "supersecretapikey1234567", level: "first_steps")
+
+api = Stockfighter::Api.new(gm.config)
+
+# Use the GM to register message callbacks for messages received from the GM. The GM needs to be initialized with polling: true to set up polling of the GM and enable callbacks.
 
-gm = Stockfighter::GM.new(key: "supersecretapikey1234567", level: "first_steps", polling:true)
+gm = Stockfighter::GM.new(key: "supersecretapikey1234567", level: "first_steps", polling: true)
 
-# Register message callbacks - GM needs to be constructed with polling:true for these callbacks to work
 gm.add_message_callback('success') { |message|
 	puts "\e[#32m#{message}\e[0m"
 }
@@ -41,8 +59,6 @@ gm.add_state_change_callback { |previous_state, new_state|
 	end
 }
 
-api = Stockfighter::Api.new(gm.config)
-
 # Restart the level
 
 gm.restart
@@ -99,12 +115,24 @@ api = Stockfighter::Api.new(key: key, account: account, symbol: symbol, venue: v
 
 ```
 
+# Websockets api example
+
+websockets = Stockfighter::Websockets.new(gm.config)
+websockets.add_quote_callback { |quote|
+	puts quote
+}
+websockets.add_execution_callback { |execution|
+	puts execution 
+}
+websockets.start()
+
+
 ## Todo
 
 * ~~TODO: Usage instructions!~~
 * ~~TODO: Game master integration~~
 * TODO: Tests
-* TODO: Error Handling
+* TODO: Error Handling (partially complete)
 
 ## Contributing
 

data/lib/stockfighter/api.rb

@@ -15,18 +15,6 @@ module Stockfighter
       HTTParty.get("#{BASE_URL}/venues/#{@venue}/stocks/#{@symbol}/quote", {"X-Starfighter-Authorization" => @api_key}).parsed_response
     end
 
-    def block_until_first_trade()
-      puts "Waiting until first trade of #{@symbol}.#{@venue}"
-
-      quote = nil
-      loop do
-        quote = get_quote
-        puts quote
-        break if quote['last'] != nil
-      end
-      quote
-    end
-
     def place_order(price:, quantity:, direction:, order_type:)
       order = {
         "account" => @account,
@@ -42,17 +30,6 @@ module Stockfighter
       headers: {"X-Starfighter-Authorization" => @api_key}).parsed_response
     end
 
-    def block_until_order_filled(order_id)
-      puts "Blocking until order #{order_id} is filled"
-
-      loop do 
-        quote = get_quote
-        order_status = order_status(order_id)
-        puts "Order Status: #{order_status['direction']} #{order_status['originalQty']} #{order_status['symbol']}.#{order_status['venue']} @ #{order_status['price']} FilledQuantity:#{order_status['totalFilled']} Last Price: #{quote['last']}"
-        break if not order_status["open"]
-      end       
-    end
-
     def cancel_order(order_id)
       HTTParty.delete("#{BASE_URL}/venues/#{@venue}/stocks/#{@symbol}/orders/#{order_id}", headers: {"X-Starfighter-Authorization" => @api_key})
     end

data/lib/stockfighter/gm.rb

@@ -13,7 +13,7 @@ module Stockfighter
 
       @callback_types = ['success', 'info']
       @message_callbacks = Hash.new { |h,k| h[k] = [] }
-      @state_change_callback = []
+      @state_change_callbacks = []
 
       new_level_response = perform_request("post", "#{GM_URL}/levels/#{level}")
       previous_state = new_level_response['state']
@@ -26,7 +26,7 @@ module Stockfighter
 
           current_state = response['state']
           if previous_state != current_state
-            @state_change_callback.each { |callback|
+            @state_change_callbacks.each { |callback|
               callback.call(previous_state, current_state)
             }
             previous_state = current_state
@@ -41,7 +41,7 @@ module Stockfighter
     end
 
     def add_state_change_callback(&block)
-      @state_change_callback << block
+      @state_change_callbacks << block
     end
 
     def config

data/lib/stockfighter/version.rb

@@ -1,3 +1,3 @@
 module Stockfighter
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/stockfighter/websockets.rb

@@ -0,0 +1,102 @@
+require 'httparty'
+require 'websocket-eventmachine-client'
+
+module Stockfighter
+  class Websockets
+
+    WS_URL = "https://www.stockfighter.io/ob/api/ws"
+
+    def initialize(key:, account:, symbol:, venue:)
+      @account = account
+      @venue = venue
+      @quote_callbacks = []
+      @execution_callbacks = []
+    end
+
+    def start() 
+
+      EM.epoll
+      EM.run do
+
+        EM.error_handler{ |e|
+          abort("Error raised during event loop: #{e}")
+        }
+
+        tickertape = WebSocket::EventMachine::Client.connect(:uri => "#{WS_URL}/#{@account}/venues/#{@venue}/tickertape", :ssl => true)
+        tickertape.onopen do
+          puts "tickertape websocket: connected"
+        end
+
+        tickertape.onmessage do |msg|
+          incoming = JSON.parse(msg)
+          if not incoming["ok"]
+            raise "tickertape websocket: Error response received: #{msg}"
+          end
+          if incoming.key?('quote')
+            quote = incoming['quote']
+            @quote_callbacks.each { |callback|
+                callback.call(quote)
+            }
+          else
+            raise "tickertape websocket: TODO: Unhandled message type: #{msg}"
+          end
+        end
+
+        tickertape.onerror do |e|
+          puts "tickertape websocket: Error #{e}"
+        end
+
+        tickertape.onping do |msg|
+          puts "tickertape websocket: Received ping: #{msg}"
+        end
+
+        tickertape.onpong do |msg|
+          puts "tickertape websocket: Received pong: #{msg}"
+        end
+
+        tickertape.onclose do
+          raise "tickertape websocket: Disconnected"
+        end
+
+        executions = WebSocket::EventMachine::Client.connect(:uri => "#{WS_URL}/#{@account}/venues/#{@venue}/executions", :ssl => true)
+        executions.onopen do
+          puts "executions websocket: Connected"
+        end
+
+        executions.onmessage do |msg|
+          execution = JSON.parse(msg)
+          if not execution["ok"]
+            raise "execution websocket: Error response received: #{msg}"
+          end
+          @execution_callbacks.each { |callback|
+            callback.call(execution)
+          }
+        end
+
+        executions.onerror do |e|
+          puts "executions websocket: Error: #{e}"
+        end
+
+        executions.onping do |msg|
+          puts "executions websocket: Received ping: #{msg}"
+        end
+
+        executions.onpong do |msg|
+          puts "executions websocket: Received pong: #{msg}"
+        end
+
+        executions.onclose do
+          raise "executions websocket: Disconnected"
+        end
+      end
+    end
+
+    def add_quote_callback(&block)
+      @quote_callbacks << block
+    end
+
+    def add_execution_callback(&block)
+      @execution_callbacks << block
+    end
+  end
+end

data/lib/stockfighter.rb

@@ -1,3 +1,4 @@
 require "stockfighter/version"
 require "stockfighter/api"
 require "stockfighter/gm"
+require "stockfighter/websockets"

data/stockfighter.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "httparty", "~> 0.13.7"
   spec.add_runtime_dependency "rufus-scheduler", "~> 3.1.10"
+  spec.add_runtime_dependency "websocket-eventmachine-client", "~> 1.1.0"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockfighter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Robert J Samson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2015-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.10
+- !ruby/object:Gem::Dependency
+  name: websocket-eventmachine-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +96,7 @@ files:
 - lib/stockfighter/api.rb
 - lib/stockfighter/gm.rb
 - lib/stockfighter/version.rb
+- lib/stockfighter/websockets.rb
 - stockfighter.gemspec
 homepage: https://github.com/rjsamson/stockfighter
 licenses: