scottrade 0.0.2

data/.gitignore

@@ -0,0 +1,19 @@
+private/
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'money'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nolan Brown
+
+MIT License
+
+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,49 @@
+# Scottrade
+
+Very basic gem for accessing Scottrade account information including balances and market positions. 
+
+**This software comes with no warranty and you use it at your own risk.**
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scottrade'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scottrade
+
+## Usage
+
+To run the tests or example, set the environment key `SCOTTRADE_ACCOUNT` and `SCOTTRADE_PASSWORD` with your account information.
+
+Basic usage is:
+
+	scottrade = Scottrade::Scottrade.new(`ACCOUNT_NUMBER`,`PASSWORD`)
+	scottrade.authenticate
+	scottrade.brokerage.update_accounts
+	scottrade.brokerage.update_positions
+	
+	print scottrade.brokerage.account_balance
+
+NOTE: Many variables will return a `Money` object, not a `String`
+
+## To Do
+
+- Add additional test coverage
+- Add ability to check quotes
+
+
+## Contributing
+
+1. Fork it
+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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/basics.rb

@@ -0,0 +1,49 @@
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'scottrade'
+
+scottrade = Scottrade::Scottrade.new(ENV["SCOTTRADE_ACCOUNT"],ENV["SCOTTRADE_PASSWORD"])
+begin
+  scottrade.authenticate
+rescue StandardError => e
+  puts e
+  exit 1
+end
+
+begin
+  scottrade.brokerage.update_accounts
+  scottrade.brokerage.update_positions
+  
+rescue StandardError => e
+  puts e
+  exit 1
+end
+
+puts scottrade.brokerage.account_balance
+##
+# The code below will output all available variables for all associated classes
+##
+
+scottrade.brokerage.instance_variables.each{|variable|
+  print "#{variable} : "; $stdout.flush
+  puts scottrade.brokerage.instance_variable_get(variable)
+}
+print "\n------------------------------------\n"
+
+scottrade.brokerage.accounts.each{|account|
+  account.instance_variables.each{|variable|
+    print "#{variable} : "; $stdout.flush
+    puts account.instance_variable_get(variable)
+  }
+  print "\n***************\n"
+}
+
+scottrade.brokerage.positions.each{|position|
+  position.instance_variables.each{|variable|
+    print "#{variable} : "; $stdout.flush
+    puts position.instance_variable_get(variable)
+  }
+  print "\n***************\n"
+}

data/lib/scottrade/account.rb

@@ -0,0 +1,32 @@
+
+module Scottrade
+  
+  class Account 
+    CASH_ACCOUNT = "Cash"
+    MARGIN_ACCOUNT = "Margin"
+    SHORT_ACCOUNT = "Short"
+    attr_reader :type, :settled_funds, :market_value, :yesterday_market_value, :total_available_for_trading, :deposited_funds, :total_value
+    
+    def initialize(details={})
+      @type = details["AccountType"]
+      @settled_funds = Money.parse details["SettledFunds"]
+      @market_value = Money.parse details["MarketValue"]
+      @yesterday_market_value = Money.parse details["YesterdayMarketValue"]
+      
+      @total_available_for_trading = Money.parse details["TotalAccountTypeFundsForTrading"]
+      @deposited_funds = Money.parse details["BankDepositProgramForTrading"]
+      
+      @total_value = Money.parse details["TotalAccountTypeValue"]
+    end
+    
+    def cash?
+      @type == CASH_ACCOUNT
+    end
+    def margin?
+      @type == MARGIN_ACCOUNT
+    end
+    def short?
+      @type == SHORT_ACCOUNT
+    end
+  end
+end

data/lib/scottrade/base.rb

@@ -0,0 +1,48 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module Scottrade
+  class Base
+    attr_accessor :session_token, :cookies
+    ::API_BASE = "https://mobappfe.scottrade.com"
+    ::API_PATH = "/middleware/MWServlet"
+    
+    def post(parameters, cookies = nil)
+      uri = URI.parse(API_BASE)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            
+      request = Net::HTTP::Post.new(API_PATH)
+      request.set_form_data(parameters)
+      
+      cookies = @cookies unless cookies
+      
+      request.add_field("Cookie",cookies.join('; ')) if cookies
+
+      response = http.request(request)
+      
+      return response
+    end
+    
+    def get(path, parameters,cookies=nil)
+      uri = URI.parse(API_BASE)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+                  
+      query_path = "#{path}"
+      query_path = "#{path}?#{URI.encode_www_form(parameters)}" if parameters.length > 0
+      request = Net::HTTP::Get.new(query_path)      
+      
+      cookies = @cookies unless cookies
+      
+      request.add_field("Cookie",cookies.join('; ')) if cookies
+            
+      response = http.request(request)
+      return response
+    end
+  end
+  
+end

data/lib/scottrade/brokerage.rb

@@ -0,0 +1,107 @@
+require 'money'
+require_relative 'account'
+require_relative 'position'
+
+module Scottrade
+  class Brokerage 
+    
+    attr_reader :total_value, :total_cash_balance, :yesterday_total_cash_balance, :available_free_cash_blanace, :account_balance
+    attr_reader :total_market_value_with_options, :total_market_value_without_options, :yesterday_total_market_value
+    attr_reader :total_settled_funds, :total_unsettled_sells, :funds_available_to_buy_non_marginables, :funds_available_to_buy_marginables
+    attr_reader :funds_available_to_buy_options, :funds_available_to_buy_mutual_funds, :funds_available_for_withdraw, :approximate_liquidation_value
+    attr_reader :accounts, :positions
+    attr_reader :current_market_value, :todays_percent_change, :todays_value_change
+    
+    def initialize(session)
+      @session = session
+    end
+    
+    # def positions
+    # 
+    # end
+    # def accounts
+    # end
+    
+    def update_accounts
+      params = {}
+      params["channel"] = "rc"
+      params["appID"] = "Scottrade"
+      params["rcid"] = "iPhone"
+      params["cacheid"] = ""
+      params["platform"] = "iPhone"
+      params["appver"] = "1.1.4"
+      params["useCachedData"] = "false"
+            
+      params["serviceID"] = "GetFrontEndMoneyBalances"
+            
+      response = @session.post(params)
+      parsed_response = JSON.parse(response.body)
+      if parsed_response["error"] == "false"
+        @total_value = Money.parse parsed_response["TotalAccountValue"]
+        @total_cash_balance = Money.parse parsed_response["TotalMoneyBalance"]
+        @yesterday_total_cash_balance = Money.parse parsed_response["YesterdayTotalMoneyBalance"]
+        @available_free_cash_blanace = Money.parse parsed_response["AvailableFreeCash"]
+        @total_market_value_with_options = Money.parse parsed_response["TotalMarketValueWithOptions"]
+        @total_market_value_without_options = Money.parse parsed_response["TotalMarketValueNoOptions"]
+        @yesterday_total_market_value = Money.parse parsed_response["YesterdayTotalMarketValue"]
+        @total_settled_funds = Money.parse parsed_response["TotalSettledFunds"]
+        @total_unsettled_sells = Money.parse parsed_response["TotalUnsettledSells"]
+        @funds_available_to_buy_non_marginables = Money.parse parsed_response["FundsAvailableToBuyNonMarginables"]
+        @funds_available_to_buy_marginables = Money.parse parsed_response["FundsAvailableToBuyMarginables"]
+        @funds_available_to_buy_options = Money.parse parsed_response["FundsAvailableToBuyOptions"]
+        @funds_available_to_buy_mutual_funds = Money.parse parsed_response["FundsAvailableToBuyMutualFunds"]
+        @funds_available_for_withdraw = Money.parse parsed_response["FundsAvailableForWithdraw"]
+        @approximate_liquidation_value = Money.parse parsed_response["TodaysChangeApproxLiquidationValNoOptions"]
+        @account_balance = Money.parse parsed_response["BrokerageAccountBalance"]
+        
+        @accounts = []
+        unparsed_accounts = parsed_response["AccTypeBalances"]
+        unparsed_accounts.each{|acct|
+          @accounts.push Account.new(acct)
+        }
+        
+      elsif parsed_response["msg"]
+        raise RequestError, parsed_response["msg"]
+      else
+        raise RequestError
+      end
+    end
+    
+    def update_positions
+      params = {}
+      params["channel"] = "rc"
+      params["appID"] = "Scottrade"
+      params["rcid"] = "iPhone"
+      params["cacheid"] = ""
+      params["platform"] = "iPhone"
+      params["appver"] = "1.1.4"
+      
+      params["useCachedData"] = "false"
+      params["startRow"] = "0"
+      params["noOfRows"] = "1000"
+      params["returnRealTimeMktValue"] = "true"
+      
+      params["serviceID"] = "GetPositions_v2"
+            
+      response = @session.post(params)
+      parsed_response = JSON.parse(response.body)
+      if parsed_response["error"] == "false"
+
+        @current_market_value = parsed_response["totalMktValue"]
+        @todays_percent_change = parsed_response["totalPctChange"]
+        @todays_value_change = parsed_response["toalPriceChange"]
+        
+        @positions = []
+        all_positions = parsed_response["Positions"]
+        all_positions.each{|pos|
+          @positions.push Position.new(pos)
+        }
+        
+      elsif parsed_response["msg"]
+        raise RequestError, parsed_response["msg"]
+      else
+        raise RequestError
+      end
+    end
+  end
+end

data/lib/scottrade/error.rb

@@ -0,0 +1,17 @@
+module Scottrade
+  class AuthenticationError < StandardError
+    def initialize(msg = "Authentication Error")
+      super(msg)
+    end
+  end
+  class UnkownError < StandardError
+    def initialize(msg = "Unkown Error")
+      super(msg)
+    end
+  end
+  class RequestError < StandardError
+    def initialize(msg = "Request Error")
+      super(msg)
+    end
+  end
+end

data/lib/scottrade/position.rb

@@ -0,0 +1,22 @@
+module Scottrade
+  class Position < Base
+    
+    attr_reader :symbol, :display_symbol, :quantity, :previous_market_close_value, :account_type, :cusip, :security_description
+    attr_reader :security_class, :previous_close_price, :realTimePrice, :real_time_price, :real_time_market_value, :price_change
+    
+    def initialize(details)
+      @symbol = details["symbol"]
+      @display_symbol = details["displaySymbol"]
+      @quantity = details["quantity"]
+      @previous_market_close_value = Money.parse(details["prevCloseMktValue"])
+      @account_type = details["accType"]
+      @cusip = details["cusip"]
+      @security_description = details["securityDescription"]
+      @security_class = details["SecurityClass"]
+      @previous_close_price = details["previousClosePrice"]
+      @real_time_price = details["realTimePrice"]
+      @real_time_market_value = Money.parse(details["RealTimeMktValue"])
+      @price_change = Money.parse(details["priceChange"])
+    end
+  end
+end

data/lib/scottrade/quote.rb

@@ -0,0 +1,7 @@
+module Scottrade
+  class Quote
+    def initialize(session)
+      @session = session
+    end
+  end
+end

data/lib/scottrade/session.rb

@@ -0,0 +1,62 @@
+require 'json'
+
+require_relative 'base'
+require_relative 'error'
+
+module Scottrade
+  class Session < Base
+    
+    attr_reader :encrypted_id, :mask_id
+    
+    def initialize(account, password)
+      @account = account
+      @password = password
+      @cookies = nil
+    end
+    def authenticated?
+      return (@cookies != nil)
+    end
+    def authenticate
+      params = {}
+      params["appID"] = "Scottrade"
+      params["appName"] = "ScottradeMobileApplication"
+      params["rcid"] = "iPhone"
+      params["osName"] = "iPhone"
+      params["platform"] = "iPhone"
+      params["cacheid"] = ""
+      params["osVer"] = "6"
+      params["appver"] = "1.1.4"
+      params["appVer"] = "1.1.4"
+      params["isRemAcc"] = "true"
+      params["page"] = "LogIn"
+      params["serviceID"] = "VerifyLogin"
+      params["channel"] = "rc"
+      params["langId"] = "English"      
+      
+      params["acc"] = @account
+      params["pwd"] = @password
+      params["isEncrypted"] = "false"
+            
+      response = post(params, nil)
+      all_cookies = response.get_fields('set-cookie') # only cookies are set on valid credentials
+      parsed_response = JSON.parse(response.body)
+      if parsed_response["error"] == "false" and !parsed_response.has_key?("errmsg")
+        cookies = []
+        all_cookies.each { | cookie |
+            cookies.push(cookie.split('; ')[0])
+        }
+        @cookies = cookies
+        @encrypted_dd = parsed_response["encryptedId"]
+        @mask_id = parsed_response["maskId"]
+        
+        return self
+      elsif parsed_response["msg"]
+        raise AuthenticationError, parsed_response["msg"]
+      elsif parsed_response["errmsg"]
+        raise AuthenticationError, parsed_response["errmsg"]
+      else
+        raise AuthenticationError
+      end   
+    end
+  end
+end

data/lib/scottrade/version.rb

@@ -0,0 +1,3 @@
+module Scottrade
+  VERSION = "0.0.2"
+end

data/lib/scottrade.rb

@@ -0,0 +1,30 @@
+require_relative "scottrade/version"
+require_relative "scottrade/session"
+require_relative "scottrade/brokerage"
+
+module Scottrade
+  class Scottrade
+    attr_reader :session
+    def initialize(account, password)
+      @session = Session.new(account, password)
+      ## 
+    end
+    def authenticate
+      response = @session.authenticate
+      if @session.authenticated?
+        return @session
+      else # error
+        return response
+      end
+    end
+    def authenticated?
+      return @session.authenticated?
+    end
+    
+    def brokerage
+      return @brokerage if @brokerage
+      @brokerage = Brokerage.new(@session)
+    end
+    
+  end
+end

data/scottrade.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scottrade/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "scottrade"
+  gem.version       = Scottrade::VERSION
+  gem.authors       = ["Nolan Brown"]
+  gem.email         = ["nolanbrown@gmail.com"]
+  gem.description   = %q{Basic gem for accessing a Scottrade account}
+  gem.summary       = gem.description 
+  gem.homepage      = "https://github.com/nolanbrown/scottrade"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency 'money'
+  
+end

data/tests/unit/auth.rb

@@ -0,0 +1,20 @@
+require 'test/unit'
+require 'rack/test'
+require '../../lib/scottrade'
+
+class AuthenticationTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def test_positive_authentication
+    scottrade = Scottrade::Scottrade.new(ENV["SCOTTRADE_ACCOUNT"],ENV["SCOTTRADE_PASSWORD"])
+    assert_nothing_raised Scottrade::AuthenticationError do
+      scottrade.authenticate
+    end
+  end
+  def test_negative_authentication
+    scottrade = Scottrade::Scottrade.new("555555555","password")
+    assert_raise Scottrade::AuthenticationError do
+      scottrade.authenticate
+    end
+  end
+end

data/tests/unit/brokerage.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+require 'rack/test'
+require '../../lib/scottrade'
+class AuthenticationTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def test_brokerage_balances
+    scottrade = Scottrade::Scottrade.new(ENV["SCOTTRADE_ACCOUNT"],ENV["SCOTTRADE_PASSWORD"])
+    assert_nothing_raised Scottrade::AuthenticationError do
+      scottrade.authenticate
+    end
+    assert_nothing_raised Scottrade::RequestError do
+      scottrade.brokerage.update_accounts
+    end
+  end
+  def test_brokerage_positions
+    scottrade = Scottrade::Scottrade.new(ENV["SCOTTRADE_ACCOUNT"],ENV["SCOTTRADE_PASSWORD"])
+    assert_nothing_raised Scottrade::AuthenticationError do
+      scottrade.authenticate
+    end
+    assert_nothing_raised Scottrade::RequestError do
+      scottrade.brokerage.update_positions
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: scottrade
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Nolan Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Basic gem for accessing a Scottrade account
+email:
+- nolanbrown@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/basics.rb
+- lib/scottrade.rb
+- lib/scottrade/account.rb
+- lib/scottrade/base.rb
+- lib/scottrade/brokerage.rb
+- lib/scottrade/error.rb
+- lib/scottrade/position.rb
+- lib/scottrade/quote.rb
+- lib/scottrade/session.rb
+- lib/scottrade/version.rb
+- scottrade.gemspec
+- tests/unit/auth.rb
+- tests/unit/brokerage.rb
+homepage: https://github.com/nolanbrown/scottrade
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Basic gem for accessing a Scottrade account
+test_files: []