fighter_base 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2cb2ebc74ae084de20a9fe8cee990dad05c5d24
-  data.tar.gz: 8b0cdd25d782ab58e1f74dec128b496ada0e0274
+  metadata.gz: 436f0bd1cf8106875580bf6cbca527c54976b887
+  data.tar.gz: 888aabf3e8cd12362896282358b1c896616a6d02
 SHA512:
-  metadata.gz: 0c372802c94fe8ee476279494e6d8731b4ed49f3cb3bcf1eff68f0f159c423d98e4687027540d90344b94a2a476bbae7e7da5e6e414fb1afd796ba7a6e5663d4
-  data.tar.gz: b91091078eff40a9e8734237aa21c373ea7450b7e862bcb9e820394e7e1983449204318f66a9a9e2a3bbf5550950516aa51a0333a97b46bae70cae0239610648
+  metadata.gz: a2ab35cf19a7257c219874686447db5618d06c97cd1505d74a9bdd9f83fd85b19172f86bc1270a74031276d41115111158f3be48ce1acf48a6b9e9ac7da9f35e
+  data.tar.gz: b8b7a74cbe566fc92dc95bec8ad9dc5f6f88c5ec6930e14253c73dcfbc3befadcdf7cc600151a9a501faa9129150a0b77d36d57c7fb471eb580d9535ce9459d3

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+Version 0.1.0: Initial version - dummy Level and Exchange classes, methods only check game and exchange heartbeat endpoints.
+
+Version 0.2.0: Enable enough interaction to complete a level. Methods Exchange#quote, Exchange#place_order, Exchange#cancel_order, and Exchange#order_status work. Order class still not implemented.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fighter_base (0.1.0)
+    fighter_base (0.2.0)
       httparty (~> 0.13.7)
 
 GEM

data/README.md

@@ -1,8 +1,6 @@
 # FighterBase
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fighter_base`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Wrapper methods for interacting with the APIs in the Stockfighter.io game.
 
 ## Installation
 
@@ -26,15 +24,33 @@ The main classes are
 
 ### Level
 
-Stores the `api_key`, and trading account
+`level = FighterBase::Level.new(api_key, account, venue_symbol)`
+
+Creating a Level instance also creates an Exchange instance of the given venue. You need the Exchange instance to get quotes and place orders.
+
+### Exchange
+
+Most interaction will be through this class. Quote for a stock, orderbook for a stock, place an order, cancel an order is done here. Methods return JSON from the APIs parsed into a hash.
+
+`ex = level.exchange`
 
-### Venue
+`quote = ex.get_quote("FAC")`
 
-Most interaction will be through this class. Quote for a stock, orderbook for a stock, place an order, cancel an order is done here.
+then get information from it as
+
+`quote["ask"]` or `quote["bid_size"]`
 
 ### Order
 
-Create orders, then place them using Venue#place_order
+Class is not implemented yet - still working how to model them in this system.
+
+Orders can be placed and canceled through the `Exchange` insance
+
+`order = ex.place_order(stock: symbol, price: ask, qty: size, direction: "buy", type: "limit")`
+
+_Note:_ `Exchange#place_order` currently returns a hash. In the future it will return a propper `Order` instance.
+
+_Note:_ Order method uses named argument style method. The rest of the methods will soon switch to that style.
 
 ## Notes
 

data/lib/fighter_base/exchange.rb

@@ -1,21 +1,66 @@
 require "httparty"
+require "json"
 
 module FighterBase
-
     class Exchange
         attr_reader :venue_symbol, :level
 
         def initialize(venue_symbol, level)
+            @base_url = "https://api.stockfighter.io/ob/api"
             @venue_symbol = venue_symbol
             @level = level
         end
 
         def heartbeat
-            response = HTTParty.get("https://api.stockfighter.io/ob/api/venues/#{@venue_symbol}/heartbeat")
+            response = HTTParty.get("#{@base_url}/venues/#{@venue_symbol}/heartbeat")
             ok = response.parsed_response["ok"] rescue false
 
             raise "World is on fire!" unless ok
             puts "lump lump, lump lump" if ok
         end
+
+        def get_quote(stock)
+            response = HTTParty.get("#{@base_url}/venues/#{@venue_symbol}/stocks/#{stock}/quote")
+            return response.parsed_response
+        end
+
+        def get_order_book(stock)
+            response = HTTParty.get("#{@base_url}/venues/#{venue_symbol}/stocks/#{stock}")
+            return response.parsed_response
+        end
+
+#        def place_order(order)
+#            response = HTTParty.post("#{@base_url}/venues/#{venue_symbol}/stocks/#{stock}/orders",
+#                         :body => JSON.dump(order),
+#                         :headers => {"X-Starfighter-Authorization" => apikey}
+#                         )
+#            return response.parsed_response
+#        end
+
+        def place_order(stock:, price:, qty:, direction:, type: "limit")
+            order_data = {
+                "account" => @level.account,
+                "venue" => @venue_symbol,
+                "symbol" => stock,
+                "price" => price,
+                "qty" => qty,
+                "direction" => direction,
+                "orderType" => type
+            }
+
+            response = HTTParty.post("#{@base_url}/venues/#{@venue_symbol}/stocks/#{stock}/orders",
+                         :body => JSON.dump(order_data),
+                         :headers => {"X-Starfighter-Authorization" => @level.api_key}
+                         )
+            return response.parsed_response
+
+        end
+
+        def cancel_order(stock, order_id)
+            response = HTTParty.delete("#{@base_url}/venues/#{venue_symbol}/stocks/#{stock}/orders/#{order_id}",
+                :headers => {"X-Starfighter-Authorization" => @level.api_key}
+                )
+            return response.parsed_response
+        end
     end
 end

data/lib/fighter_base/level.rb

@@ -2,10 +2,11 @@ require "httparty"
 
 module FighterBase
     class Level
-        attr_reader :api_key, :exchange
+        attr_reader :api_key, :account, :exchange
 
-        def initialize(api_key, venue_symbol)
+        def initialize(api_key, account, venue_symbol)
             @api_key = api_key
+            @account = account
             @exchange = Exchange.new(venue_symbol, self)
         end
 

data/lib/fighter_base/order.rb

@@ -0,0 +1,7 @@
+require 'httparty'
+
+module FighterBase
+    class Order
+        attr_accessor :type, :price, :quantity, :total_filled, :open, :symbol, :fills
+    end
+end

data/lib/fighter_base/version.rb

@@ -1,3 +1,3 @@
 module FighterBase
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fighter_base
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brian Broom
 autorequire: 
 bindir: exe
 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
@@ -78,6 +78,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md