scottrade 0.0.2 → 0.0.3

data/README.md

@@ -4,6 +4,7 @@ Very basic gem for accessing Scottrade account information including balances an
 
 **This software comes with no warranty and you use it at your own risk.**
 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/nolanbrown/scottrade)
 
 ## Installation
 

data/examples/basics.rb

@@ -12,14 +12,14 @@ rescue StandardError => e
   exit 1
 end
 
-begin
+#begin
   scottrade.brokerage.update_accounts
   scottrade.brokerage.update_positions
   
-rescue StandardError => e
-  puts e
-  exit 1
-end
+# rescue StandardError => e
+#   puts e
+#   exit 1
+# end
 
 puts scottrade.brokerage.account_balance
 ##

data/lib/scottrade/brokerage.rb

@@ -1,9 +1,11 @@
 require 'money'
 require_relative 'account'
 require_relative 'position'
+require_relative 'helpers'
 
 module Scottrade
   class Brokerage 
+    include Scottrade::Helpers
     
     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
@@ -12,96 +14,94 @@ module Scottrade
     attr_reader :accounts, :positions
     attr_reader :current_market_value, :todays_percent_change, :todays_value_change
     
+    KEYS_TO_VARIABLES = {
+      # accounts data keys
+      "TotalAccountValue"                         => { :key => :total_value, :is_money => true },
+      "TotalMoneyBalance"                         => { :key => :total_cash_balance, :is_money => true },
+      "YesterdayTotalMoneyBalance"                => { :key => :yesterday_total_cash_balance, :is_money => true },
+      "AvailableFreeCash"                         => { :key => :available_free_cash_blanace, :is_money => true },
+      "TotalMarketValueWithOptions"               => { :key => :total_market_value_with_options, :is_money => true },
+      "TotalMarketValueNoOptions"                 => { :key => :total_market_value_without_options, :is_money => true },
+      "YesterdayTotalMarketValue"                 => { :key => :yesterday_total_market_value, :is_money => true },
+      "TotalSettledFunds"                         => { :key => :total_settled_funds, :is_money => true },
+      "TotalUnsettledSells"                       => { :key => :total_unsettled_sells, :is_money => true },
+      "FundsAvailableToBuyNonMarginables"         => { :key => :funds_available_to_buy_non_marginables, :is_money => true },
+      "FundsAvailableToBuyMarginables"            => { :key => :funds_available_to_buy_marginables, :is_money => true },
+      "FundsAvailableToBuyOptions"                => { :key => :funds_available_to_buy_options, :is_money => true },
+      "FundsAvailableToBuyMutualFunds"            => { :key => :funds_available_to_buy_mutual_funds, :is_money => true },
+      "FundsAvailableForWithdraw"                 => { :key => :funds_available_for_withdraw, :is_money => true },
+      "TodaysChangeApproxLiquidationValNoOptions" => { :key => :approximate_liquidation_value, :is_money => true },
+      "BrokerageAccountBalance"                   => { :key => :account_balance, :is_money => true },
+      # positions data keys
+      "totalMktValue"                             => { :key => :current_market_value, :is_money => false },
+      "totalPctChange"                            => { :key => :todays_percent_change,  :is_money => false },
+      "toalPriceChange"                           => { :key => :todays_value_change, :is_money => false },
+    }
+
+    
     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 = request_parameters("GetFrontEndMoneyBalances")
             
-      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
+      response = session_post(params)
+      set_variables_from_response(response)
+
+      @accounts = []
+      unparsed_accounts = response["AccTypeBalances"]
+      unparsed_accounts.each{|acct|
+        @accounts.push Account.new(acct)
+      }
+      
     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 = request_parameters("GetPositions_v2")
       params["startRow"] = "0"
       params["noOfRows"] = "1000"
       params["returnRealTimeMktValue"] = "true"
       
       params["serviceID"] = "GetPositions_v2"
-            
+      
+      response = session_post(params)
+      
+      set_variables_from_response(response)
+      
+      @positions = []
+      all_positions = response["Positions"]
+      all_positions.each{|pos|
+        @positions.push Position.new(pos)
+      }
+    end    
+    
+    private
+    def session_post(params)
       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)
-        }
-        
+        return parsed_response
       elsif parsed_response["msg"]
         raise RequestError, parsed_response["msg"]
       else
         raise RequestError
       end
     end
+    
+    def set_variables_from_response(response)
+      response.each{|key,value|
+        settings = KEYS_TO_VARIABLES[key]
+        if settings
+          if settings[:is_money]
+            begin
+            value = Money.parse value
+            rescue
+            end
+          end
+          instance_variable_set("@#{settings[:key].to_s}", value)
+        end
+      }
+    end
   end
 end

data/lib/scottrade/helpers.rb

@@ -0,0 +1,17 @@
+
+module Scottrade
+  module Helpers    
+    def request_parameters(serviceID)
+      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"] = serviceID
+      params
+    end
+  end
+end

data/lib/scottrade/position.rb

@@ -4,19 +4,31 @@ module Scottrade
     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)
+    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"])
+      begin
+        @price_change = Money.parse details["priceChange"].split("\n")[0]
+      rescue
+        @price_change = Money.parse("$0.00")
+      end
+      begin
+        @previous_market_close_value = Money.parse(details["prevCloseMktValue"])
+      rescue
+        @previous_market_close_value = Money.parse("$0.00")
+      end
+      begin
+        @real_time_market_value = Money.parse(details["RealTimeMktValue"])
+      rescue
+        @previous_market_close_value = Money.parse("$0.00")
+      end
     end
   end
 end

data/lib/scottrade/session.rb

@@ -2,9 +2,11 @@ require 'json'
 
 require_relative 'base'
 require_relative 'error'
+require_relative 'helpers'
 
 module Scottrade
   class Session < Base
+    include Scottrade::Helpers
     
     attr_reader :encrypted_id, :mask_id
     
@@ -17,46 +19,45 @@ module Scottrade
       return (@cookies != nil)
     end
     def authenticate
-      params = {}
-      params["appID"] = "Scottrade"
+      params = request_parameters("VerifyLogin")
       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)
+      response = authentication_post(params)
       all_cookies = response.get_fields('set-cookie') # only cookies are set on valid credentials
       parsed_response = JSON.parse(response.body)
+      
+      @cookies = []
+      all_cookies.each { | cookie |
+          @cookies.push(cookie.split('; ')[0])
+      }
+      @encrypted_dd = parsed_response["encryptedId"]
+      @mask_id = parsed_response["maskId"]
+      
+      return self 
+    end
+    
+    private
+    def authentication_post(params)
+      response = post(params)
+      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
+        return response
       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
 end

data/lib/scottrade/version.rb

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

data/tests/unit/auth.rb

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

data/tests/unit/brokerage.rb

@@ -1,25 +1,24 @@
 require 'test/unit'
 require 'rack/test'
-require '../../lib/scottrade'
+require_relative 'helpers'
+require_relative '../../lib/scottrade'
+
 class AuthenticationTest < Test::Unit::TestCase
   include Rack::Test::Methods
-
+  include ScottradeUnitTestHelpers
   def test_brokerage_balances
-    scottrade = Scottrade::Scottrade.new(ENV["SCOTTRADE_ACCOUNT"],ENV["SCOTTRADE_PASSWORD"])
-    assert_nothing_raised Scottrade::AuthenticationError do
-      scottrade.authenticate
-    end
+    authenticate(ENV["SCOTTRADE_ACCOUNT"],ENV["SCOTTRADE_PASSWORD"])
+    
     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
+    authenticate(ENV["SCOTTRADE_ACCOUNT"],ENV["SCOTTRADE_PASSWORD"])
+    
     assert_nothing_raised Scottrade::RequestError do
       scottrade.brokerage.update_positions
     end
   end
+  
 end

data/tests/unit/helpers.rb

@@ -0,0 +1,8 @@
+module ScottradeUnitTestHelpers
+  def authenticate(username, password)
+    scottrade = Scottrade::Scottrade.new(username, password)
+    assert_nothing_raised Scottrade::AuthenticationError do
+      scottrade.authenticate
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scottrade
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-10 00:00:00.000000000 Z
+date: 2013-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -45,6 +45,7 @@ files:
 - lib/scottrade/base.rb
 - lib/scottrade/brokerage.rb
 - lib/scottrade/error.rb
+- lib/scottrade/helpers.rb
 - lib/scottrade/position.rb
 - lib/scottrade/quote.rb
 - lib/scottrade/session.rb
@@ -52,6 +53,7 @@ files:
 - scottrade.gemspec
 - tests/unit/auth.rb
 - tests/unit/brokerage.rb
+- tests/unit/helpers.rb
 homepage: https://github.com/nolanbrown/scottrade
 licenses: []
 post_install_message: