chock_a_block 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61eac32feffc31892a866b93630c02d84274154f
+  data.tar.gz: 677f850db05f1cb59da016806a43095f0ce4f250
+SHA512:
+  metadata.gz: a4877e9e853be54c86325aa1e53e97185c06c0bc0ba5f02f6aa5e678fb0feb1d10a0725d900b8a5d363bc50ff29397c43c9d94362c09dd6a0b3f609a6bcae371
+  data.tar.gz: d259a1b9a20153211ab925f07c1b411ed4bbc8e156a7ed16a18d7f6a0dccaa13af506b1c1ae0139088b34177577c41f25cc22577585debe6a67cf4bd4df0d668

data/lib/chock_a_block/algo_trader.rb

@@ -0,0 +1,87 @@
+module ChockABlock
+  class AlgoTrader
+    include Errors
+
+    # The total amount of stocks to buy
+    TOTAL_AMOUNT = 100_000
+
+    def initialize(api_key, account, venue, symbol)
+      @currntly_bought = 0
+      @last_bidding_price = Float::INFINITY
+      @stock  = Stock.new(venue, symbol)
+      @broker = Broker.new(api_key, account, venue, symbol)
+    end
+
+    def basic_strategy
+      # Use a ticker to reset orders every 5 times
+      # to avoid sticking with very low bidding price
+      ticker = 0
+      success_ticker = 0
+
+      while TOTAL_AMOUNT > @currntly_bought
+        begin
+          # Get best bidding price/qty from stock orderbook
+          bid = @stock.best_bidding
+
+          # reset every 10_000 attempts to avoid stalling for too long
+          # NOTE: this is not important and the game can be finished without it
+          # NOTE: but it increases the success rate of the algorithm
+          ticker += 1
+          if ticker > 10_000
+            ticker = 0
+            orders = @broker.get_orders
+            update_status(orders)
+            cancel_orders_and_reset_bidding_price(orders)
+          end
+
+          # Place order if price market price is reasonable
+          # and the current bidding price offered is lower than our last price
+          next if @last_bidding_price < bid['price']
+          @broker.place_order(bid['price'] + 1, bid['qty'])
+          @last_bidding_price = bid['price']
+          sleep 2
+
+          # Get Status about current orders count
+          orders = @broker.get_orders
+          update_status(orders)
+
+          # reset every 10 successful attempts to avoid flooding bidding size
+          # NOTE: this is not important and the game can be finished without it
+          # NOTE: but it increases the success rate of the algorithm
+          success_ticker += 1
+          cancel_orders_and_reset_bidding_price(orders) if success_ticker % 10 == 0
+        rescue ChockABlock::OrderError => e
+          p 'Something went wrong while placing order'
+          p e.message
+          p 'Retrying'
+          retry
+        rescue ChockABlock::StockNotFoundError, ChockABlock::VenueNotFoundError => e
+          # when the game ends the Venue and Stock are removed so
+          # any request done after that return
+          p 'Sorry, The game ended before we finish, :('
+          p '--------------------------------------------------------'
+          return
+        end
+      end
+      p 'Congratulations, We successfully finished :D'
+      p '--------------------------------------------------------'
+    end
+
+    # calculate the sum of currently bought stocks from orders
+    # and print out the current progress
+    def update_status(orders)
+      @currntly_bought = orders.map{|order| order['totalFilled']}.inject :+
+      # print progress
+      p "Progress: #{(@currntly_bought.to_f / TOTAL_AMOUNT.to_f * 100.0).round(1)}%"
+    end
+
+    # cancel all orders after certain ticks to avoid pushing the market
+    # into the higher price.
+    # and set the last bidding price high to avoid stucking with a very
+    # low bidding price.
+    def cancel_orders_and_reset_bidding_price(orders)
+      @last_bidding_price = Float::INFINITY
+      orders.each{|order| @broker.cancel_order(order['id'])}
+    end
+  end
+end

data/lib/chock_a_block/broker.rb

@@ -0,0 +1,85 @@
+module ChockABlock
+  class Broker
+    include Errors
+
+    # Initialize a Broker to interact with API
+    # placing orders and getting order stats... etc.
+    #
+    # @param api_key [String] API auth key
+    # @param account [String] account id for given game
+    # @param venue   [String] venue name
+    # @param symbol  [String] stock symbol
+    def initialize(api_key, account, venue, symbol)
+      @api_key = api_key
+      @account = account
+      @venue   = venue
+      @symbol  = symbol
+    end
+
+    # Place an order
+    # API Consumer
+    #
+    # @param price [Integer] price for buying
+    # @param qty   [Integer] quantity wanted to buy
+    #
+    # @return [Hash] representing the placed order
+    def place_order(price, qty)
+      response = HTTP['X-Starfighter-Authorization' => @api_key].post(
+        BASE_URL + "/venues/#{@venue}/stocks/#{@symbol}/orders",
+        json: {
+          account:   @account,
+          venue:     @venue,
+          stock:     @symbol,
+          price:     price,
+          qty:       qty,
+          direction: :buy,
+          orderType: :limit
+        }
+      )
+      response_body = JSON.parse response.body
+      fail AuthenticationError, @api_key if response.code == 401
+      fail OrderError, response_body['error'] unless response_body['ok']
+      response_body
+    end
+
+    # Get all the orders of a specific stock
+    # API Consumer
+    #
+    # @return [Hash] representing the order in query
+    def get_orders
+      response = HTTP['X-Starfighter-Authorization' => @api_key].get(
+        BASE_URL + "/venues/#{@venue}/accounts/#{@account}/stocks/#{@symbol}/orders"
+      )
+      fail AuthenticationError, @api_key if response.code == 401
+      JSON.parse(response.body)['orders']
+    end
+
+    # Get specific order details
+    # API Consumer
+    #
+    # @params id [Integer] representing the order id to query
+    #
+    # @return [Hash] representing the order in query
+    def get_order(id)
+      response = HTTP['X-Starfighter-Authorization' => @api_key].get(
+        BASE_URL + "/venues/#{@venue}/stocks/#{@symbol}/orders/#{id}"
+      )
+      fail AuthenticationError, @api_key if response.code == 401
+      JSON.parse response.body
+    end
+
+    # Cancel specific order details
+    # API Consumer
+    #
+    # @params id [Integer] representing the order id to cancel
+    #
+    # @return [Hash] representing the order cancelled
+    def cancel_order(id)
+      response = HTTP['X-Starfighter-Authorization' => @api_key].delete(
+        BASE_URL + "/venues/#{@venue}/stocks/#{@symbol}/orders/#{id}"
+      )
+      fail AuthenticationError, @api_key if response.code == 401
+      JSON.parse response.body
+    end
+  end
+end

data/lib/chock_a_block/errors.rb

@@ -0,0 +1,23 @@
+module ChockABlock
+  module Errors
+    # Base Error
+    class ChockABlockError < StandardError
+    end
+
+    # 401 error
+    class AuthenticationError < ChockABlockError
+    end
+
+    # Error when stock symbol is not found
+    class VenueNotFoundError < ChockABlockError
+    end
+
+    # Error when stock symbol is not found
+    class StockNotFoundError < ChockABlockError
+    end
+
+    # Error when placing order fails
+    class OrderError < ChockABlockError
+    end
+  end
+end

data/lib/chock_a_block/stock.rb

@@ -0,0 +1,50 @@
+module ChockABlock
+  class Stock
+    include Errors
+
+    # Initialize a Stock resource API consumer
+    #
+    # @param venue  [String] venue name
+    # @param symbol [String] stock symbol
+    def initialize(venue, symbol)
+      @venue  = venue
+      @symbol = symbol
+    end
+
+    # Get the orderbook for specific STOCK_SYMBOL in a specific VENUE
+    # API Consumer
+    #
+    # @return [Hash] representing the response of the stock orderbook
+    def get_orderbook
+      response = HTTP.get(BASE_URL + "/venues/#{@venue}/stocks/#{@symbol}")
+      fail StockNotFoundError, @symbol if response.code == 500
+      fail VenueNotFoundError, @venue  if response.code == 404
+      JSON.parse response.body
+    end
+
+    # Get the qoute for a specific STOCK_SYMBOL in a specifc VENUE
+    # API Consumer
+    #
+    # @return [Hash] representing the response of the stock quote
+    def get_quote
+      response = HTTP.get(BASE_URL + "/venues/#{@venue}/stocks/#{@symbol}/quote")
+      fail StockNotFoundError, @symbol if response.code == 404
+      JSON.parse response.body
+    end
+
+    # Get the best bidding currently available on the orderbook
+    #
+    # @return [Hash] representing the best current price/qty offered by bots
+    # or retry if best_bid is nil
+    def best_bidding
+      @order_book = get_orderbook
+      best_bid = @order_book['bids']&.last
+
+      return best_bid unless best_bid.nil?
+
+      # retryl few seconds later
+      sleep 2
+      best_bidding
+    end
+  end
+end

data/lib/chock_a_block.rb

@@ -0,0 +1,47 @@
+# Require 3rd party dependencies
+require 'json'
+require 'http'
+
+# Require relative core classes (dependencies)
+require_relative 'chock_a_block/errors'
+require_relative 'chock_a_block/stock'
+require_relative 'chock_a_block/broker'
+require_relative 'chock_a_block/algo_trader'
+
+# The Base Module to solve chock_a_block challange on stockerfighter.io
+# Provide easy way of consuming the api to start level
+# and configure the correct venue, stock and account
+module ChockABlock
+  include Errors
+
+  BASE_URL = 'https://api.stockfighter.io/ob/api'
+  GAME_URL = 'https://www.stockfighter.io/gm/'
+
+  # Provide an easy way to start the game consuming the api
+  # instead of copying and pasting the account/venue/symbol of each game
+  def self.start_level(api_key)
+    response = HTTP['X-Starfighter-Authorization' => api_key].post(
+      GAME_URL + 'levels/chock_a_block'
+    )
+    response_body = JSON.parse response.body
+    fail AuthenticationError, api_key unless response_body['ok']
+
+    # Get the level data using the undocumented API here
+    # https://discuss.starfighters.io/t/the-gm-api-how-to-start-stop-restart-resume-trading-levels-automagically/143
+    @accout   = response_body['account']
+    @venue    = response_body['venues'].first
+    @symbol   = response_body['tickers'].first
+    @instance = response_body['instanceId']
+
+    p 'Game Started'
+    p 'Please Navigate to:'
+    p '   https://www.stockfighter.io/ui/play/blotter#chock_a_block'
+    p 'to see the game in action'
+    p '--------------------------------------------------------'
+    # Start the AlgoTrader
+    AlgoTrader.new(api_key, @accout, @venue, @symbol).basic_strategy
+  rescue AuthenticationError => e
+    p "Invalid API_KEY #{e.message}"
+    p 'Please use a correct API_KEY to start the level'
+  end
+end

data/spec/chock_a_block_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe ChockABlock do
+  it 'has a version number' do
+    expect(ChockABlock::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'chock_a_block'

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: chock_a_block
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ahmed Abdel-Razzak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- abdelrazzak.ahmed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/chock_a_block.rb
+- lib/chock_a_block/algo_trader.rb
+- lib/chock_a_block/broker.rb
+- lib/chock_a_block/errors.rb
+- lib/chock_a_block/stock.rb
+- spec/chock_a_block_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/artmees/chock_a_block
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Solution to chock_a_block
+test_files: []
+has_rdoc: