stock_fighter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3aec0e9fae963679c7a6dc7d578c71a8266bbd0a
+  data.tar.gz: fdecba1ef331c5ed7fa538f34e840bbfa1bd62cb
+SHA512:
+  metadata.gz: 498eff0bd4d0664dc2d097253b67f7a71fafeee59c46b163ec8c3c7a1f3c7a26c8cc4e9ca0a648685970bfb9936b70c752dfbdc7a79c1dbf887f4c5c2365ed05
+  data.tar.gz: a097f519b34b8cd8aab02eeb4151ed2cdba39855fc1bf63f1bc608a03cbcdd68d8d7c3d0725e547b3a609c8303d64ec152e389c309c44fbee51de1cb2abdc938

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stock_fighter.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jing Yang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# StockFighter
+
+An (unofficial) API for [stockfighter.io](http://stockfighter.io). Designed to be friendly to scripting. Run `bin/console` and start trading!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stock_fighter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stock_fighter
+
+## Usage for Scripting
+
+See the following script. The code can also be found in `examples/test_exchange.rb`. Detailed API is listed in `lib/stock_fighter/api_mixin`.
+
+```ruby
+require 'stock_fighter/api_mixin'
+
+include StockFighter::ApiMixin
+
+# Set your API key.
+set_api_key "your_api_key_here"
+
+venue = "TESTEX"
+stock = "FOOBAR"
+account = "EXB123456"
+
+# Test if the service is up.
+ok = send_heartbeat.parsed_response["ok"] rescue false
+
+raise "Can't sent heart beat" unless ok
+
+# Get the current orderbook.
+orderbook = get_orderbook venue, stock
+
+raise "Can't get orderbook" unless orderbook["ok"]
+
+p "bids: ", orderbook["bids"]
+p "asks: ", orderbook["asks"]
+
+# Place an order!
+# By default the direction is 'buy' and order type is 'limit'.
+order = place_order venue, stock, account, price: 100, qty: 1, direction: :buy, order_type: :limit
+
+# There should be an error unless a valid API key is supplied.
+p order
+```
+
+As a side effect, all objects will have extra methods :-).
+
+TODO: add examples for more serious coding style.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/stock_fighter.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stock_fighter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+include StockFighter::ApiMixin
+
+puts """Welcome to the StockFighter Console!
+
+Please start by setting your API key:
+
+  set_api_key 'your_api_key_here'
+
+Supported commands:
+
+  send_heartbeat
+  send_venue_heartbeat venue
+
+  list_stocks venue
+  get_orderbook venue, stock
+
+  place_order venue, stock, account, price:, qty:, direction: 'buy', order_type: 'limit'
+  show_order venue, stock, order
+  cancel_order venue, stock, order
+
+  get_quote venue, stock
+
+  list_account_orders venue, account
+  list_account_stock_orders venue, account, stock
+
+See http://stockfighter.io for API details.
+
+Other commands
+  http : A httparty object to send http request, usage: http.get, http.post etc.
+"""
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/test_exchange.rb

@@ -0,0 +1,30 @@
+require 'stock_fighter/api_mixin'
+
+include StockFighter::ApiMixin
+
+# Set your API key.
+set_api_key "your_api_key_here"
+
+venue = "TESTEX"
+stock = "FOOBAR"
+account = "EXB123456"
+
+# Test if the service is up.
+ok = send_heartbeat.parsed_response["ok"] rescue false
+
+raise "Can't sent heart beat" unless ok
+
+# Get the current orderbook.
+orderbook = get_orderbook venue, stock
+
+raise "Can't get orderbook" unless orderbook["ok"]
+
+p "bids: ", orderbook["bids"]
+p "asks: ", orderbook["asks"]
+
+# Place an order!
+# By default the direction is 'buy' and order type is 'limit'.
+order = place_order venue, stock, account, price: 100, qty: 1, direction: :buy, order_type: :limit
+
+# There should be an error unless a valid API key is supplied.
+p order

data/lib/stock_fighter/api.rb

@@ -0,0 +1,13 @@
+module StockFighter
+  class Api
+    include ApiMixin
+
+    def initialize api_key
+      self.set_api_key api_key
+    end
+
+    def connect_to_level level_name
+      Level.new level_name, self
+    end
+  end
+end

data/lib/stock_fighter/api_mixin.rb

@@ -0,0 +1,86 @@
+require 'httparty'
+require 'json'
+
+# TODO: better testing.
+module StockFighter
+  module ApiMixin
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    def set_api_key api_key
+      http.headers "X-Starfighter-Authorization" => api_key
+    end
+
+    def send_heartbeat
+      http.get "/heartbeat"
+    end
+
+    def send_venue_heartbeat venue
+      http.get "/venues/#{venue}/heartbeat"
+    end
+
+    def list_stocks venue
+      http.get "/venues/#{venue}/stocks"
+    end
+
+    def get_orderbook venue, stock
+      http.get "/venues/#{venue}/stocks/#{stock}"
+    end
+
+    def place_order venue, stock, account, price:, qty:, direction: "buy", order_type: "limit"
+      params = method(__method__).parameters.map(&:last)
+      body = params.map { |p| [p, eval(p.to_s)] }.to_h
+
+      body[:orderType] = body.delete(:order_type)
+
+      http.post "/venues/#{venue}/stocks/#{stock}/orders", body: JSON.dump(body)
+    end
+
+    def show_order venue, stock, order
+      http.post "/venues/#{venue}/stocks/#{stock}/orders/#{order}"
+    end
+
+    def cancel_order venue, stock, order
+      http.delete "/venues/#{venue}/stocks/#{stock}/orders/#{order}"
+    end
+
+    def get_quote venue, stock
+      http.get "/venues/#{venue}/stocks/#{stock}/quote"
+    end
+
+    def list_account_orders venue, account
+      http.get "/venues/#{venue}/accounts/#{account}/orders"
+    end
+
+    def list_account_stock_orders venue, account, stock
+      http.get "get/venues/#{venue}/accounts/#{account}/stocks/#{stock}/orders"
+    end
+
+    private
+    def http
+      # TODO: how do we create module specific vars?
+      @http_delegator ||= ApiMixin.create_partified_module
+    end
+
+    def self.create_partified_module
+      Module.new do
+        include HTTParty
+
+        base_uri 'https://api.stockfighter.io/ob/api'
+        format :json
+      end
+    end
+
+    module ClassMethods
+      private
+      def share_http_delegator
+        http_delegator = ApiMixin.create_partified_module
+        define_method :http do
+          http_delegator
+        end
+        private :http
+      end
+    end
+  end
+end

data/lib/stock_fighter/level.rb

@@ -0,0 +1,30 @@
+require 'stock_fighter/api_mixin'
+
+module StockFighter
+  class Level
+    def initialize level_name, api = nil, api_key: nil, account: nil, venue: nil, stock: nil
+      raise "Must provide an API key, or an Api instance." if api.nil? and api_key.nil?
+
+      @name = level_name
+      @delegator = api or StockFighter.create_api api_key
+
+      @defaults = {}
+      @defaults[:account] = account unless account.nil?
+      @defaults[:venue] = venue unless venue.nil?
+      @defaults[:stock] = stock unless stock.nil?
+    end
+
+    ApiMixin.instance_methods.each do |method|
+      required_params = ApiMixin.instance_method(method).parameters.select do |pair|
+        pair.first == :req
+      end.map(&:last)
+
+      define_method method do |*args, &block|
+        prefilled = required_params.map do |param|
+          @defaults[param]
+        end
+        @delegator.send method, *(prefilled + args), &block
+      end
+    end
+  end
+end

data/lib/stock_fighter/version.rb

@@ -0,0 +1,3 @@
+module StockFighter
+  VERSION = "0.0.1"
+end

data/lib/stock_fighter.rb

@@ -0,0 +1,9 @@
+require "stock_fighter/version"
+require "stock_fighter/level"
+require "stock_fighter/api"
+
+module StockFighter
+  def self.create_api api_key
+    Api.new api_key
+  end
+end

data/stock_fighter.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stock_fighter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stock_fighter"
+  spec.version       = StockFighter::VERSION
+  spec.authors       = ["Jing Yang"]
+  spec.email         = ["ditsing@gmail.com"]
+
+  spec.summary       = %q{Better stockfighter.io API, friendly to scripting.}
+  spec.description   = %q{API for http://stockfighter.io. Run bin/console and start playing!}
+  spec.homepage      = "http://github.com/ditsing/stock_fighter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", "~> 0.13.7"
+  spec.add_runtime_dependency "json", "~> 1.8.3"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: stock_fighter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jing Yang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: API for http://stockfighter.io. Run bin/console and start playing!
+email:
+- ditsing@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/test_exchange.rb
+- lib/stock_fighter.rb
+- lib/stock_fighter/api.rb
+- lib/stock_fighter/api_mixin.rb
+- lib/stock_fighter/level.rb
+- lib/stock_fighter/version.rb
+- stock_fighter.gemspec
+homepage: http://github.com/ditsing/stock_fighter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Better stockfighter.io API, friendly to scripting.
+test_files: []