stockfighter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2415edd3367b4bd4a7aaee2be6c976f258e19b6
-  data.tar.gz: bac5606e0f110665800cce19238e514707ada46c
+  metadata.gz: 4bdefa6e0159b52f4476baedc42858dd71702d5e
+  data.tar.gz: ef6409e0478881f99d93a0ff0b8682dec4e0127f
 SHA512:
-  metadata.gz: be8405a6810b219119b72a66dfc6d256b02c926a4078828dce3b96411b57d7e30ccec46d983b35dbc64f4941a623aa154d5a049c004de6993afe9cfec71b0cd7
-  data.tar.gz: 50ecccfd0332ec27b79455efb4ebcf66047a7bac5a88c729c8262b5cad57a82d17e42fc4e99ae8a79da9190001cc4a49765eccdb1bec5dc06594e27edca46451
+  metadata.gz: 9aa733983e97db7249013f080f079f35f2ef53fb3a1f447c6d750be0b666e7acd11a59298964971a9b1a1049d21b229ddb37600d06f6acb421b7d2f5adec11c3
+  data.tar.gz: 025ec520598bada4e9e57f83794d18937eaf94c2abb94d189bc44f85aac2df3819436fd2dc442d99a4a3c070780d6db88492f9ec363d6b3c4706cb0fd02fde1a

data/README.md

@@ -20,11 +20,66 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Example
+```ruby
+require 'stockfighter'
+
+# Use the GM to fetch the info automatically
+
+gm = Stockfighter::GM.new("supersecretapikey1234567")
+first_steps_config = gm.fetch_info_for(level: "first_steps")
+
+api = Stockfighter::Api.new(first_steps_config)
+
+# Or initialize manually
+
+key = "supersecretapikey1234567"
+account = "ACT123456789"
+symbol = "ABC"
+venue = "DEFGHEX"
+
+api = Stockfighter::Api.new(key: key, account: account, symbol: symbol, venue: venue)
+
+# Print the order book
+puts api.order_book
+
+# Check if the venue is up
+puts api.venue_up?
+
+# Print a quote
+puts api.get_quote
+
+# Print the whole order book
+puts api.order_book
+
+# Place an order
+order = api.place_order(price: 4250, quantity: 100, direction: "buy", order_type: "limit")
+
+# Check the status of an order
+order_id = order["id"]
+order_status = api.order_status(order_id)
+puts order_status["open"]
+puts order_status["fills"]
+puts order_status["totalFilled"]
+
+# Cancel an order
+cancellation = api.cancel_order(order_id)
+puts cancellation["totalFilled"]
+
+# Print the status of all your orders for the stock on the venue
+puts api.status_all
+
+```
+
+## Todo
+
+* ~~TODO: Usage instructions!~~
+* ~~TODO: Game master integration~~
+* TODO: Tests
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/stockfighter/fork )
+1. Fork it ( https://github.com/rjsamson/stockfighter/fork )
 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`)

data/lib/stockfighter.rb

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

data/lib/stockfighter/gm.rb

@@ -0,0 +1,25 @@
+require 'httparty'
+
+module Stockfighter
+  class GM
+    def initialize(key)
+      @api_key = key
+    end
+
+    def config_for(level:)
+      resp = HTTParty.post("https://www.stockfighter.io/gm/levels/#{level}", :headers => {"X-Starfighter-Authorization" => @api_key})
+
+      config = {}
+      config[:account] = resp["account"]
+      config[:venue] = resp["venues"][0]
+      config[:symbol] = resp["tickers"][0]
+      config[:key] = @api_key
+
+      if config[:account] && config[:venue] && config[:symbol]
+        config
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/stockfighter/version.rb

@@ -1,3 +1,3 @@
 module Stockfighter
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockfighter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Robert J Samson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2015-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -66,6 +66,7 @@ files:
 - Rakefile
 - lib/stockfighter.rb
 - lib/stockfighter/api.rb
+- lib/stockfighter/gm.rb
 - lib/stockfighter/version.rb
 - stockfighter.gemspec
 homepage: https://github.com/rjsamson/stockfighter