stockfighter 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68adc328d3d355eff80ad92e8254f5e96ce8a0f1
-  data.tar.gz: b3ee6f33a1e53a8fe9661e5708c67c21f24b642b
+  metadata.gz: 732fe76a171ed98a78d642e01b24606254ca687b
+  data.tar.gz: d2798df2beb98d49509180d44196ec8a0ed6d444
 SHA512:
-  metadata.gz: 600d0eb1c467c8292b9dfe1b914e78092a885f109cf70018026c2500b578e8342fdd060d52a38237946ec92d6e91e5fa094f8c0eda93d075eb97db6044a7602f
-  data.tar.gz: a021f108dacd96883bb97eb513ddbb06972b6fb408fea03c602e0cf2ce6ef0985160c4bbd4c6fac24ee661bddf2be01537eecccdb89619a0a9ee9b2334c998d1
+  metadata.gz: 5f44263691227792ed908acc7f9eb009889bcf4b3f2dbe936499cab18ef3ca3632a1cb04f4016ee091da2f763cf316baaf753663d363f303b11608f8d5b56f2d
+  data.tar.gz: dd09455db5254b0d77438738a3b35cde95f66ffcd8cd7562e8136028706d939bf8626568f29760fbd545f458a0535f7d7c80ab3cac23d039d506a4149effabaf

data/README.md

@@ -43,22 +43,33 @@ 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.
+# Use the GM to register message callbacks for messages received & trading day notification 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.add_message_callback('success') { |message|
-	puts "\e[#32m#{message}\e[0m"
-}
-gm.add_message_callback('info') { |message|
-	puts "\e[#34m#{message}\e[0m"
+ansi_code = Hash.new
+ansi_code['success'] = "\e[#32m"
+ansi_code['info']    = "\e[#34m"
+ansi_code['warning'] = "\e[#33m"
+ansi_code['error']   = "\e[#31m"
+ansi_code['danger']  = "\e[#31m"
+
+gm.add_message_callback { |type,message|
+	abort("Unhandled message type #{type}") unless ansi_code.key?(type)
+	puts "#{ansi_code[type]}#{message}\e[0m"
 }
+
 gm.add_state_change_callback { |previous_state, new_state|
 	if new_state == 'won'
 		puts "You've won!"
 	end
 }
 
+gm.add_trading_day_callback { |previous_trading_day, current_trading_day, end_of_the_world_day|
+	# Due to the relatively infrequent polling (to avoid rate limiting), the callback will not be called on every individual trading day
+}
+
 # Restart the level
 
 gm.restart
@@ -120,19 +131,37 @@ api = Stockfighter::Api.new(key: key, account: account, symbol: symbol, venue: v
 ```ruby
 websockets = Stockfighter::Websockets.new(gm.config)
 websockets.add_quote_callback { |quote|
+	# Ensure you don't have long running operations (eg calling api.*) as part of this 
+	# callback method as the event processing for all websockets is performed on 1 thread. 
 	puts quote
 }
+
 websockets.add_execution_callback { |execution|
+	# Ensure you don't have long running operations (eg calling api.*) as part of this 
+	# callback method as the event processing for all websockets is performed on 1 thread. 
 	puts execution
 }
+
 websockets.start()
+
+# The tickertape websocket can be optionally disabled when calling start()
+
+websockets = Stockfighter::Websockets.new(gm.config)
+websockets.add_execution_callback { |execution|
+	puts execution
+}
+
+websockets.start(tickertape_enabled:false)
+
+# The executions websocket can also be disabled by passing executions_enabled:false when calling start()
+
 ```
 
 ## Todo
 
 * ~~TODO: Usage instructions!~~
 * ~~TODO: Game master integration~~
-* TODO: Tests
+* TODO: Tests!
 * TODO: Error Handling (partially complete)
 
 ## Contributing
@@ -141,4 +170,7 @@ websockets.start()
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+5. Write some tests
+6. Run all the tests using the following command:
+	`API_KEY="insert_your_api_key_here" rake test`
+7. Create a new Pull Request

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+require "minitest"
 
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/stockfighter/api.rb

@@ -2,9 +2,8 @@ require 'httparty'
 
 module Stockfighter
   class Api
-    BASE_URL = "https://api.stockfighter.io/ob/api"
-
-    def initialize(key:, account:, symbol:, venue:)
+    def initialize(key:, account:, symbol:, venue:, base_url: "https://api.stockfighter.io/ob/api")
+      @base_url = base_url
       @api_key = key
       @account = account
       @symbol = symbol
@@ -12,7 +11,7 @@ module Stockfighter
     end
 
     def get_quote
-      HTTParty.get("#{BASE_URL}/venues/#{@venue}/stocks/#{@symbol}/quote", auth_header).parsed_response
+      perform_request("get", "#{@base_url}/venues/#{@venue}/stocks/#{@symbol}/quote")
     end
 
     def place_order(price:, quantity:, direction:, order_type:)
@@ -25,37 +24,49 @@ module Stockfighter
         "direction" => direction,
         "orderType" => order_type
       }
-
-      HTTParty.post("#{BASE_URL}/venues/#{@venue}/stocks/#{@symbol}/orders", body: JSON.dump(order),
-      headers: auth_header).parsed_response
+      perform_request("post", "#{@base_url}/venues/#{@venue}/stocks/#{@symbol}/orders", body: JSON.dump(order))
     end
 
     def cancel_order(order_id)
-      HTTParty.delete("#{BASE_URL}/venues/#{@venue}/stocks/#{@symbol}/orders/#{order_id}", headers: auth_header)
+      perform_request("delete", "#{@base_url}/venues/#{@venue}/stocks/#{@symbol}/orders/#{order_id}")
     end
 
     def order_status(order_id)
-      HTTParty.get("#{BASE_URL}/venues/#{@venue}/stocks/#{@symbol}/orders/#{order_id}", headers: auth_header).parsed_response
+      perform_request("get", "#{@base_url}/venues/#{@venue}/stocks/#{@symbol}/orders/#{order_id}")
     end
 
     def order_book
-      HTTParty.get("#{BASE_URL}/venues/#{@venue}/stocks/#{@symbol}", headers: auth_header).parsed_response
+      perform_request("get", "#{@base_url}/venues/#{@venue}/stocks/#{@symbol}")
     end
 
     def venue_up?
-      response = HTTParty.get("#{BASE_URL}/venues/#{@venue}/heartbeat", headers: auth_header).parsed_response
+      response = perform_request("get", "#{@base_url}/venues/#{@venue}/heartbeat")
       response["ok"]
     end
 
     def status_all
-      HTTParty.get("#{BASE_URL}/venues/#{@venue}/accounts/#{@account}/orders", headers: auth_header)
+      perform_request("get", "#{@base_url}/venues/#{@venue}/accounts/#{@account}/orders")
     end
 
-    def auth_header
-      {"X-Starfighter-Authorization" => @api_key}
-    end
+    def perform_request(action, url, body:nil)
+      options = {
+        :headers => {"X-Starfighter-Authorization" => @api_key},
+        :format => :json
+      }
+      if body != nil
+        options[:body] = body
+      end
+      response = HTTParty.method(action).call(url, options)
 
-    private :auth_header
+      if response.code == 200 and response["ok"]
+        response
+      elsif not response["ok"]
+        raise "Error response received from #{url}: #{response['error']}"
+      else
+        raise "HTTP error response received from #{url}: #{response.code}"
+      end
+    end
 
+    private :perform_request
   end
 end

data/lib/stockfighter/gm.rb

@@ -11,12 +11,13 @@ module Stockfighter
       @api_key = key
       @level = level
 
-      @callback_types = ['success', 'info']
-      @message_callbacks = Hash.new { |h,k| h[k] = [] }
+      @message_callbacks = []
       @state_change_callbacks = []
+      @trading_day_callbacks = []
 
       new_level_response = perform_request("post", "#{GM_URL}/levels/#{level}")
       previous_state = new_level_response['state']
+      previous_trading_day = 0
 
       if polling
         # websocket API functionality instead of polling would be great here
@@ -31,19 +32,34 @@ module Stockfighter
             }
             previous_state = current_state
           end
+
+          if response.key?('details')
+            details = response['details']
+            current_trading_day = details['tradingDay']
+            end_of_the_world_day = details['endOfTheWorldDay']
+            if previous_trading_day != current_trading_day
+              @trading_day_callbacks.each { |callback|
+                callback.call(previous_trading_day, current_trading_day, end_of_the_world_day)
+              }
+              previous_trading_day = current_trading_day
+            end
+          end
         end
       end
     end
 
-    def add_message_callback(type, &block)
-      raise "Unknown message callback type #{type}" unless @callback_types.include? type
-      @message_callbacks[type] << block
+    def add_message_callback(&block)
+      @message_callbacks << block
     end
 
     def add_state_change_callback(&block)
       @state_change_callbacks << block
     end
 
+    def add_trading_day_callback(&block)
+      @trading_day_callbacks << block
+    end
+
     def config
       if @config[:account] && @config[:venue] && @config[:symbol]
         @config
@@ -74,7 +90,11 @@ module Stockfighter
     end
 
     def perform_request(action, url)
-      response = HTTParty.method(action).call(url, :headers => {"X-Starfighter-Authorization" => @api_key})
+      options = {
+        :headers => {"X-Starfighter-Authorization" => @api_key},
+        :format => :json
+      }
+      response = HTTParty.method(action).call(url, options)
       if response.code != 200
         raise "HTTP error response received from #{url}: #{response.code}"
       end
@@ -84,17 +104,11 @@ module Stockfighter
 
       if response.key?('flash')
         flash = response['flash']
-        if flash.key?('success')
-          @message_callbacks['success'].each { |callback|
-            callback.call(flash['success'])
+        flash.each { |type,message|
+          @message_callbacks.each { |callback|
+            callback.call(type, message)
           }
-        elsif flash.key?('info')
-          @message_callbacks['info'].each { |callback|
-            callback.call(flash['info'])
-          }
-        else
-          raise "TODO: Unhandled flash scenario: #{response}"
-        end
+        }
       end
 
       if response.key?('instructions')

data/lib/stockfighter/version.rb

@@ -1,3 +1,3 @@
 module Stockfighter
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/stockfighter/websockets.rb

@@ -13,7 +13,7 @@ module Stockfighter
       @execution_callbacks = []
     end
 
-    def start() 
+    def start(tickertape_enabled:true, executions_enabled:true)
 
       EM.epoll
       EM.run do
@@ -22,71 +22,85 @@ module Stockfighter
           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
+        if tickertape_enabled
+          tickertape_options = {
+            :uri => "#{WS_URL}/#{@account}/venues/#{@venue}/tickertape", 
+            :ssl => true
+          }
 
-        tickertape.onmessage do |msg|
-          incoming = JSON.parse(msg)
-          if not incoming["ok"]
-            raise "tickertape websocket: Error response received: #{msg}"
+          tickertape = WebSocket::EventMachine::Client.connect(tickertape_options)
+          tickertape.onopen do
+            puts "#{@account} tickertape websocket: connected"
           end
-          if incoming.key?('quote')
-            quote = incoming['quote']
-            @quote_callbacks.each { |callback|
-                callback.call(quote)
-            }
-          else
-            raise "tickertape websocket: TODO: Unhandled message type: #{msg}"
+
+          tickertape.onmessage do |msg|
+            incoming = JSON.parse(msg)
+            if not incoming["ok"]
+              raise "#{@account} tickertape websocket: Error response received: #{msg}"
+            end
+            if incoming.key?('quote')
+              quote = incoming['quote']
+              @quote_callbacks.each { |callback|
+                  callback.call(quote)
+              }
+            else
+              raise "#{@account} tickertape websocket: TODO: Unhandled message type: #{msg}"
+            end
           end
-        end
 
-        tickertape.onerror do |e|
-          puts "tickertape websocket: Error #{e}"
-        end
+          tickertape.onerror do |e|
+            puts "#{@account} tickertape websocket: Error #{e}"
+          end
 
-        tickertape.onping do |msg|
-          puts "tickertape websocket: Received ping: #{msg}"
-        end
+          tickertape.onping do |msg|
+            puts "#{@account} tickertape websocket: Received ping: #{msg}"
+          end
 
-        tickertape.onpong do |msg|
-          puts "tickertape websocket: Received pong: #{msg}"
-        end
+          tickertape.onpong do |msg|
+            puts "#{@account} tickertape websocket: Received pong: #{msg}"
+          end
 
-        tickertape.onclose do
-          raise "tickertape websocket: Disconnected"
+          tickertape.onclose do |code, reason|
+            raise "#{@account} tickertape websocket: Client disconnected with status code: #{code} and reason: #{reason}"
+          end
         end
 
-        executions = WebSocket::EventMachine::Client.connect(:uri => "#{WS_URL}/#{@account}/venues/#{@venue}/executions", :ssl => true)
-        executions.onopen do
-          puts "executions websocket: Connected"
-        end
+        if executions_enabled
+          executions_options = {
+            :uri => "#{WS_URL}/#{@account}/venues/#{@venue}/executions", 
+            :ssl => true
+          }
 
-        executions.onmessage do |msg|
-          execution = JSON.parse(msg)
-          if not execution["ok"]
-            raise "execution websocket: Error response received: #{msg}"
+          executions = WebSocket::EventMachine::Client.connect(executions_options)
+          executions.onopen do
+            puts "#{@account} executions websocket: connected"
           end
-          @execution_callbacks.each { |callback|
-            callback.call(execution)
-          }
-        end
 
-        executions.onerror do |e|
-          puts "executions websocket: Error: #{e}"
-        end
+          executions.onmessage do |msg|
+            execution = JSON.parse(msg)
+            if not execution["ok"]
+              raise "#{@account} execution websocket: Error response received: #{msg}"
+            end
+            @execution_callbacks.each { |callback|
+              callback.call(execution)
+            }
+          end
 
-        executions.onping do |msg|
-          puts "executions websocket: Received ping: #{msg}"
-        end
+          executions.onerror do |e|
+            puts "#{@account} executions websocket: Error: #{e}"
+          end
 
-        executions.onpong do |msg|
-          puts "executions websocket: Received pong: #{msg}"
-        end
+          executions.onping do |msg|
+            puts "#{@account} executions websocket: Received ping: #{msg}"
+          end
 
-        executions.onclose do
-          raise "executions websocket: Disconnected"
+          executions.onpong do |msg|
+            puts "#{@account} executions websocket: Received pong: #{msg}"
+          end
+
+          executions.onclose do |code, reason|
+            raise "#{@account} executions websocket: Client disconnected with status code: #{code} and reason: #{reason}"
+          end
         end
       end
     end

data/stockfighter.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "websocket-eventmachine-client", "~> 1.1"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8.3"
 end

data/test/test_api.rb

@@ -0,0 +1,76 @@
+require 'minitest/autorun'
+require 'stockfighter'
+
+class ApiTest < Minitest::Unit::TestCase
+	def test_get_quote
+		api = get_api()
+
+		quote = api.get_quote()
+		assert_equal 'FOOBAR', quote['symbol']
+		assert_equal 'TESTEX', quote['venue']
+		assert quote.key?('quoteTime')
+	end
+
+	def test_place_order_invalid_scenarios
+		api = get_api()
+
+		assert_raises(RuntimeError) {
+			api.place_order(price:10000000, quantity:100, direction:'invalid_direction', order_type:'limit')
+		}
+		assert_raises(RuntimeError) {
+			api.place_order(price:10000000, quantity:100, direction:'buy', order_type:'invalid_order_type')
+		}
+		assert_raises(RuntimeError) {
+			api.place_order(price:-1, quantity:100, direction:'buy', order_type:'limit')
+		}
+		assert_raises(RuntimeError) {
+			api.place_order(price:10000000, quantity:-1, direction:'buy', order_type:'limit')
+		}
+	end
+
+	def test_place_order_happy_day
+		api = get_api()
+
+		order = api.place_order(price:10, quantity:100, direction:'sell', order_type:'limit')
+		assert_equal 'FOOBAR', order['symbol']
+		assert_equal 'TESTEX', order['venue']
+		assert_equal 'sell', order['direction']
+		assert_equal 10, order['price']
+		assert_equal 'limit', order['orderType']
+		assert_equal 'EXB123456', order['account']
+
+		assert order.key?('ts')
+		assert order.key?('fills')
+	end
+
+	def test_cancel_order_invalid_scenarios
+		api = get_api()
+
+		assert_raises(RuntimeError) {
+			api.cancel_order(1)
+		}
+	end
+
+	def test_cancel_order_happy_day
+		api = get_api()
+
+		order = api.place_order(price:1, quantity:1000000, direction:'buy', order_type:'limit')
+		assert order['open']
+
+		cancel_response = api.cancel_order(order['id'])
+		assert !cancel_response['open']
+	end
+
+	def get_api
+		api_key = ENV['API_KEY']
+		assert api_key.to_s != '', "export API_KEY='secret' before running these tests, where 'secret' is your API key"
+
+		config = {
+			:key => api_key,
+			:account => 'EXB123456',
+			:venue => 'TESTEX',
+			:symbol => 'FOOBAR',
+		}
+		Stockfighter::Api.new(config)
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockfighter
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Robert J Samson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-22 00:00:00.000000000 Z
+date: 2016-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.3
 description: An API wrapper for Starfighter's Stockfighter - see www.stockfighter.io
 email:
 - rjsamson@me.com
@@ -98,6 +112,7 @@ files:
 - lib/stockfighter/version.rb
 - lib/stockfighter/websockets.rb
 - stockfighter.gemspec
+- test/test_api.rb
 homepage: https://github.com/rjsamson/stockfighter
 licenses:
 - MIT
@@ -122,4 +137,5 @@ rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: An API wrapper for Starfighter's Stockfighter
-test_files: []
+test_files:
+- test/test_api.rb