fsxtrader 1.0.0

data/History.txt

@@ -0,0 +1,8 @@
+== 1.0.0 / 2007-08-21
+
+* First ALPHA release of FSX Trader
+  * Seems to work fine on OS X, should work on *nix as well
+  * Added documentation / README
+  * Commented some of the tcode for a lil rdoc readability
+  * Tests _not_ added yet
+

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/fsxtrader
+lib/fsxtrader.rb
+lib/fsxtrader/application.rb
+lib/fsxtrader/quote_parser.rb
+lib/fsxtrader/trade.rb
+lib/fsxtrader/trader.rb
+test/test_fsxtrader.rb

data/README.txt

@@ -0,0 +1,133 @@
+fsxtrader
+    by Shanti A. Braford
+    http://shanti.railsblog.com/
+
+== DESCRIPTION:
+  
+* FSX Trader allows you to automate trading on the Fantasy Stock Exchange app on Facebook
+* Uses the WWW::Mechanize library (a ruby gem) to simulate a browser logging into Facebook, making trades, etc
+
+== FEATURES/PROBLEMS:
+  
+* Order types supported: buy, short, sell and cover
+* Pulls real-time stock quotes from Yahoo! Finance
+
+== SYNOPSIS:
+
+  Fantasy Stock Exchange app on Facebook (by HedgeStop.com):
+  http://apps.facebook.com/hedgestop/
+
+  As of this writing, the Fantasy Stock Exchange application on Facebook
+  does not allow one to place stop-limit orders or otherwise automatically
+  trigger a buy/sell or cover/short order based upon specified prices.
+  
+  FSX Trader, when combined with a periodic cron job, can make these trades
+  for you.
+  
+  Simply configure your trades in the '~/.fsx_trader.yml' file and they
+  will happen automatically whenever FSX Trader is run AND conditions for
+  making a trade (as specified via the config file) have been met.
+
+  Note: fsxtrader of course depends upon the external HTML form variables
+  of the FSX App and Facebook login page.  If these variables have changed,
+  fsxtrader be temporarily broken until the gem can be updated.
+  
+  A programmatic API into FSX would be ideal, but is currently not yet offered
+  by HedgeStop.
+  
+== REQUIREMENTS:
+
+* Currently only works on OS X or Linux
+* Other gems required: mechanize and cooloptions
+
+== INSTALL:
+
+* sudo gem install fsxtrader
+* fsxtrader setup
+* Now edit your '~/.fsx_config.yml' file, either by hand or using: fsxtrader edit
+* Add a cron job to run fsx periodically on your system
+* For more options, run: fsxtrader --help
+
+== SAMPLE CRON:
+  
+  Note: market hours are 9:30 AM to 4:00 PM EST
+  
+  The following cron job would run fsxtrader every ten minutes
+  during the hours from 7 AM to 3PM (Sample West Coast config):
+
+  0-59/10 7-15 * * * fsxtrader
+  
+  Every five minutes from 9 AM to 4 PM  (Sample East Coast config):
+
+  0-59/5 9-16 * * * fsxtrader
+  
+  If the above are giving you problems try doing a 'which fsxtrader' and using its
+  full path in the cron job or try:
+
+  0-59/5 9-16 * * * `which fsxtrader` >> /path/to/a/fsxlog.txt
+  
+== SAMPLE CONFIG:
+
+  auth:
+    email: your_fb_email@gmail.com
+    pass: your_fb_password
+  trades:
+  # Format:
+  #   prefix_key: symbol condition price action shares
+  #
+  # Options
+  #   symbol    - any valid NYSE or Nasdaq ticker tradeable on the FSX
+  #   action    - any of 'sell', 'cover', 'buy', 'short'
+  #   condition - any of '>', '>=', '<', '<='
+  #   shares    - any integer between 1 and 500000
+  #
+  # Note: "prefix_key" must be a unique string, i.e. if you want to have two trade triggers
+  # in place for the same ticker symbol (WMT), you could do:
+  #   wmt_long: WMT <= 18.5 buy 500
+  #   wmt_short: WMT >= 57 short 1500
+  #
+  # The above config tells FSX Trader to do the following:
+  #   * buy 500 shares of WMT (Wal-Mart Stores Inc) when its share price reaches 18.5 or lower
+  #   * short 1500 shares of WMT (Wal-Mart Stores Inc) when its share prices reaches 57 or greater
+  #
+  #
+  # Configurations to automatically make NEW positions:
+  #
+  # Buy 20000 shares of CSCO if its price hits 15 dollars or lower:
+     buy_low_csco: CSCO <= 15 buy 20000
+  #
+  # Short 1700 shares of AAPL if its price hits 220:
+     short_appl: AAPL >= 220 short 1700
+  #
+  # Configurations to automatically get out of EXISTING positions:
+  #
+  # Sell 2000 shares of GOOG if its price hits 500:
+     goog: GOOG >= 500 sell 2000
+  #
+  # Cover 10000 shares of LEND if its price hits 1.75:
+     cover_lend: LEND <= 1.75 cover 10000
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Shanti A. Braford
+
+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/Rakefile

@@ -0,0 +1,24 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/fsxtrader.rb'
+
+Hoe.new('fsxtrader', Fsxtrader::VERSION) do |p|
+  p.rubyforge_name = 'fsxtrader'
+  p.author = 'Shanti A. Braford'
+  p.email = 'shantibraford@gmail.com'
+  p.summary = 'FSX Trader is a ruby client app that can be used to automatically make trades for you on the Fantasy Stock Exchange app on Facebook (powered by Hedgestop).'
+  p.description = p.paragraphs_of('README.txt', 2..6).join("\n\n")
+  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.remote_rdoc_dir = ''
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps << ['mechanize', '>= 0.6.10']
+  p.extra_deps << ['cooloptions', '>= 1.1.1']
+  p.url = "http://fsxtrader.rubyforge.org"
+end
+
+desc "Release and publish documentation"
+task :repubdoc => [:release, :publish_docs]
+
+# vim: syntax=Ruby

data/bin/fsxtrader

@@ -0,0 +1,7 @@
+begin
+  require 'fsxtrader'
+rescue LoadError
+  require 'rubygems'
+  require 'fsxtrader'
+end
+Fsxtrader.application.run

data/lib/fsxtrader.rb

@@ -0,0 +1,37 @@
+$:.unshift(File.dirname(__FILE__)+"/fsxtrader/")
+
+# System gems
+require 'rubygems'
+require 'mechanize'
+require 'open-uri'
+require 'cooloptions'
+
+# FSX Trader classes
+require 'application'
+require 'quote_parser'
+require 'trader'
+require 'trade'
+
+class MissingQuoteError < StandardError; end
+
+class Time
+  # Prints the date like:  Monday, June 10 of 2006 at 10:57AM
+  def pretty_print
+    return self.strftime("%A, %B %d of %Y at %I:%M %p")
+  end
+end
+
+module Fsxtrader
+  VERSION = '1.0.0'
+
+  # Current Rake Application
+  def self.application
+    @application ||= Fsxtrader::Application.new
+  end
+
+  # Set the current Rake application object.
+  def self.application=(app)
+    @application = app
+  end
+end
+

data/lib/fsxtrader/application.rb

@@ -0,0 +1,163 @@
+module Fsxtrader
+
+  class Application
+    
+    # Initializes a new Fsxtrader::Application object.
+    #
+    # Note: this should always get called via a Singleton in the main
+    # Fsxtrader module as such: Fsxtrader.application.run
+    #
+    def initialize
+    end
+    
+    # Main FSX Trader Application entry point.
+    # * Parses command-line options and calls methods accordingly
+    def run
+      @options = CoolOptions.parse!("[options] (setup|edit|help|run)") do |o|
+        o.desc help_txt
+        o.on "(v)erbose",              "Turn on verbose mode",                                       false
+        o.on "config-path PATH",       "Path to config file",        self.default_config_path
+
+        o.after do |r|
+          if (r.config_path == self.default_config_path) && !File.exist?(self.default_config_path)
+            setup
+            exit
+          end
+          unless File.exist?(r.config_path)
+            o.error("\nERROR: Invalid config file path: #{r.config_path}\nRun 'fsxtrader setup' to create the default config file.")
+          end
+          r.action = ARGV.shift || 'run'
+        end
+      end
+
+      case @options.action
+      when 'setup'
+        setup
+      when 'edit'
+        edit
+      when 'run'
+        go
+      when 'help'
+        help
+      else
+        help
+      end
+
+    end
+    
+    # Displays the help text
+    def help
+      puts help_txt
+    end
+    
+    # Creates the default config file in: ~/fsx_config.yml
+    def setup
+      File.open(self.default_config_path, 'w') do |f|
+        f.puts self.sample_config
+      end
+
+      puts '
+Default config file has been created in:
+
+  ~/.fsx_config.yml
+
+Edit this file with any text editor or run:
+
+  fsxtrader edit
+
+Note: Be sure to edit your Facebook credentials in the config file!
+
+
+To run FSX Trader and trigger actionable trades:
+
+  fsxtrader
+
+'
+    end
+    
+    # Edit the fsx trader config file (using the system editor)
+    def edit
+      puts "Editing FSX Trader..."
+      editor = ENV['editor'] || 'vi'
+      system "#{editor} #{self.default_config_path}"
+    end
+    
+    # Runs the main FSX Trader application
+    # * loads config file and checks for trade triggers
+    # * pulls down any applicable stock quotes
+    # * makes trades if any trade conditions have been met
+    def go
+      puts "Running FSX Trader..."
+      trader = Fsxtrader::Trader.new(@options)
+    end
+
+    private
+    
+    def default_config_path
+      home = ENV['HOME']
+      return File.join(home, '.fsx_config.yml')
+    end
+    
+    def help_txt
+      '
+To setup the initial config file, execute: 
+
+  fsxtrader setup
+
+Edit trades using your system edtiro:
+
+  fsxtrader edit
+
+To check for actionable trades and execute them, simlpy run:
+
+  fsxtrader
+
+'
+    end
+    
+    def sample_config
+      'auth:
+  email: your_fb_email@gmail.com
+  pass: your_fb_password
+trades:
+  # Format:
+  #   prefix_key: symbol condition price action shares
+  #
+  # Options
+  #   symbol    - any valid NYSE or Nasdaq ticker tradeable on the FSX
+  #   action    - any of \'sell\', \'cover\', \'buy\', \'short\'
+  #   condition - any of \'>\', \'>=\', \'<\', \'<=\'
+  #   shares    - any integer between 1 and 500000
+  #
+  # Note: "prefix_key" must be a unique string.  If you want to have two trade triggers
+  # in place for the same ticker symbol (WMT), you could do:
+  #   wmt_long: WMT <= 18.5 buy 500
+  #   wmt_short: WMT >= 57 short 1500
+  #
+  # The above config tells FSX Trader to do the following:
+  #   * buy 500 shares of WMT (Wal-Mart Stores Inc) when its share price reaches 18.5 or lower
+  #   * short 1500 shares of WMT (Wal-Mart Stores Inc) when its share prices reaches 57 or greater
+  #
+  #
+  # Configurations to automatically make NEW positions:
+  #
+  # Buy 20000 shares of CSCO if its price hits 15 dollars or lower:
+  #   buy_low_csco: CSCO <= 15 buy 20000
+  #
+  # Short 1700 shares of AAPL if its price hits 220:
+  #   short_appl: AAPL >= 220 short 1700
+  #
+  # Configurations to automatically get out of EXISTING positions:
+  #
+  # Sell 2000 shares of GOOG if its price hits 500:
+  #   goog: GOOG >= 500 sell 2000
+  #
+  # Cover 10000 shares of LEND if its price hits 1.75:
+  #   cover_lend: LEND <= 1.75 cover 10000
+
+'
+    end
+
+  end
+
+end

data/lib/fsxtrader/quote_parser.rb

@@ -0,0 +1,20 @@
+module Fsxtrader
+  class QuoteParser
+    attr_accessor :quotes
+    def initialize(symbols)
+      @url = "http://finance.yahoo.com/d/quotes.csv?s=#{symbols.join('+').upcase}&f=sl1"
+      @raw_csv = open(@url)
+      parse
+    end
+
+    def parse
+      @quotes = Hash.new
+      @raw_csv.each_line do |line|
+        #puts "Parsed Yahoo Stock Quote Line: #{line}"
+        line.gsub!('"', '')
+        symbol, price = *line.split(',')
+        @quotes[symbol] = price.to_f
+      end
+    end
+  end
+end

data/lib/fsxtrader/trade.rb

@@ -0,0 +1,17 @@
+module Fsxtrader
+  class Trade
+    attr_accessor :key, :symbol, :condition, :limit_price, :action, :shares
+    attr_accessor :trade_str
+    def initialize(key, trade_str)
+      # Expected params: "RDN >= 17.25 cover 110000"
+      #            or  : "IBM <= 85 sell 50000"
+      @key = key
+      @trade_str = trade_str
+      @symbol, @condition, @limit_price, @action, @shares = *trade_str.split
+      @shares = @shares.gsub(',', '') # strip commas
+    end
+    def to_s
+      "#{action} #{shares} of #{symbol} when it is #{condition} #{limit_price}"
+    end
+  end
+end

data/lib/fsxtrader/trader.rb

@@ -0,0 +1,152 @@
+require 'fileutils'
+
+module Fsxtrader
+
+  class Trader
+    
+    # Initializes a new Fsxtrader::Trader class
+    # * Expects an OpenStruct returned from a CoolOptions.parse!(...) call
+    def initialize(options)
+      @agent = WWW::Mechanize.new
+      @agent.user_agent_alias = 'Mac FireFox'
+      @agent.redirect_ok = true
+
+      @config_file = options.config_path
+      @verbose = options.verbose || false
+
+      yml = File.open(@config_file)
+      @config = YAML.load(yml)
+      @auth = @config['auth']
+      
+      return unless everything_ok?
+      
+      @trades = []
+      @config['trades'].each do |key, val|
+        @trades << Trade.new(key, val)
+      end
+      if @trades.empty?
+        puts "No trades found."
+        return
+      else
+        puts "Trades Found:"
+        @trades.each do |t|
+          puts "\t#{t.key}: #{t.trade_str}"
+        end
+      end
+      symbols = @trades.collect { |trade| trade.symbol }
+      qp = QuoteParser.new(symbols)
+      @quotes = qp.quotes
+      check
+    end
+    
+    # Check trades
+    def check
+      # First make sure we have a quote for each trade
+      quote_symbols = @quotes.keys
+      @trades.each do |trade|
+        raise MissingQuoteError, "for symbol: #{trade.symbol}" unless quote_symbols.include?(trade.symbol)
+      end
+      # Check prices
+      @trades.each do |trade|
+        puts "Trade: #{trade}" if @verbose
+        current_price = @quotes[trade.symbol]
+        puts "\tCurrent Price: #{current_price}" if @verbose
+        cond = "#{current_price} #{trade.condition} #{trade.limit_price}"
+        condition_met = eval(cond)
+        puts "\tCondition met?: #{condition_met}" if @verbose
+        if condition_met
+          make_trade(trade)
+        end
+      end
+    end
+    
+    # Make a trade
+    def make_trade(trade)
+      login if !logged_in?
+
+      trade_type = 'old' if ['sell', 'cover'].include?(trade.action)
+      trade_type = 'new' if ['buy', 'short'].include?(trade.action)
+
+      trade_url = "http://apps.facebook.com/hedgestop/index.php?p=trade&type=#{trade_type}&ticker="
+
+      page = @agent.get(trade_url)
+      form = page.form('place_order')
+      b = form.buttons[1]
+
+      if @verbose
+        pp page
+        puts "\nForm: \n"
+        pp form
+        pp b
+      end
+
+      case trade_type
+      when 'old'
+        button = (trade.action == 'sell') ? form.buttons[0] : form.buttons[1]
+      when 'new'
+        button = (trade.action == 'buy') ? form.buttons[0] : form.buttons[1]
+      end
+      form.ticker = trade.symbol
+      form.shares = trade.shares
+      confirm_page = @agent.submit(form, button)
+      pp confirm_page if @verbose
+
+      confirm_form = confirm_page.form('confirm_order')
+      @agent.submit(confirm_form)
+
+      puts "Trade Executed: #{trade}"
+
+      # So that we don't execute this same trade again:
+      comment_out_trade(trade)
+    end
+    
+    # Comments out a trade in the config file - this gets called after
+    # every successful trade (so that duplicate trades do not occur).
+    def comment_out_trade(trade)
+      config_txt = File.read(@config_file)
+      config_txt.gsub!("#{trade.key}:", "# Trade Executed on #{Time.now.pretty_print}:\n  # #{trade.key}(executed):")
+      FileUtils.mv(@config_file, "#{@config_file}.bak")
+      # Now write out the new file
+      File.open(@config_file, 'w') do |f|
+        f.puts config_txt
+      end
+    end
+
+    private
+
+    def everything_ok?
+      if 'your_fb_email@gmail.com' == @auth['email']
+        puts "\nPlease set your Facebook login credentials in the config file: ~/.fsx_config.yml\n\nOR using your system editor by running:\n\n  fsxtrader edit\n\n"
+        return false
+      end
+      
+      if @config['trades'].nil?
+        puts "No trades found."
+        return false
+      end
+      
+      return true # everything's okay
+    end
+
+    def logged_in?
+      @logged_in
+    end
+
+    def login
+      page = @agent.get('http://www.facebook.com/')
+      pp page if @verbose
+
+      login_form = page.forms.first
+
+      login_form.email = @auth['email']
+      login_form.pass = @auth['pass']
+
+      pp login_form if @verbose
+
+      page = @agent.submit(login_form)
+      pp page if @verbose
+      @logged_in = true
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: fsxtrader
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-08-21 00:00:00 -07:00
+summary: FSX Trader is a ruby client app that can be used to automatically make trades for you on the Fantasy Stock Exchange app on Facebook (powered by Hedgestop).
+require_paths: 
+- lib
+email: shantibraford@gmail.com
+homepage: http://fsxtrader.rubyforge.org
+rubyforge_project: fsxtrader
+description: "== FEATURES/PROBLEMS:  * Order types supported: buy, short, sell and cover * Pulls real-time stock quotes from Yahoo! Finance  == SYNOPSIS:  Fantasy Stock Exchange app on Facebook (by HedgeStop.com): http://apps.facebook.com/hedgestop/  As of this writing, the Fantasy Stock Exchange application on Facebook does not allow one to place stop-limit orders or otherwise automatically trigger a buy/sell or cover/short order based upon specified prices.  FSX Trader, when combined with a periodic cron job, can make these trades for you.  Simply configure your trades in the '~/.fsx_trader.yml' file and they will happen automatically whenever FSX Trader is run AND conditions for making a trade (as specified via the config file) have been met.  Note: fsxtrader of course depends upon the external HTML form variables of the FSX App and Facebook login page.  If these variables have changed, fsxtrader be temporarily broken until the gem can be updated.  A programmatic API into FSX would be ideal, but is currently not yet offered by HedgeStop.  == REQUIREMENTS:"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Shanti A. Braford
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/fsxtrader
+- lib/fsxtrader.rb
+- lib/fsxtrader/application.rb
+- lib/fsxtrader/quote_parser.rb
+- lib/fsxtrader/trade.rb
+- lib/fsxtrader/trader.rb
+- test/test_fsxtrader.rb
+test_files: 
+- test/test_fsxtrader.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: 
+- fsxtrader
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.10
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cooloptions
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: