schwab_rb 0.2.0 → 0.3.2

data/lib/schwab_rb/clients/base_client.rb

@@ -10,6 +10,7 @@ require_relative "../data_objects/market_hours"
 require_relative "../data_objects/quote"
 require_relative "../data_objects/transaction"
 require_relative "../data_objects/order"
+require_relative "../data_objects/market_movers"
 
 module SchwabRb
   class BaseClient
@@ -161,13 +162,9 @@ module SchwabRb
       # @param return_data_objects [Boolean] Whether to return data objects or raw JSON
       refresh_token_if_needed
 
-      if from_entered_datetime.nil?
-        from_entered_datetime = DateTime.now.new_offset(0) - 60
-      end
+      from_entered_datetime = DateTime.now.new_offset(0) - 60 if from_entered_datetime.nil?
 
-      if to_entered_datetime.nil?
-        to_entered_datetime = DateTime.now
-      end
+      to_entered_datetime = DateTime.now if to_entered_datetime.nil?
 
       status = convert_enum(status, SchwabRb::Order::Statuses) if status
 
@@ -287,22 +284,22 @@ module SchwabRb
       refresh_token_if_needed
 
       transaction_types = if transaction_types
-        convert_enum_iterable(transaction_types, SchwabRb::Transaction::Types)
+                            convert_enum_iterable(transaction_types, SchwabRb::Transaction::Types)
       else
         get_valid_enum_values(SchwabRb::Transaction::Types)
-      end
+                          end
 
       start_date = if start_date.nil?
-        format_date_as_iso("start_date", DateTime.now.new_offset(0) - 60)
+                     format_date_as_iso("start_date", DateTime.now.new_offset(0) - 60)
       else
         format_date_as_iso("start_date", start_date)
-      end
+                   end
 
       end_date = if end_date.nil?
-        format_date_as_iso("end_date", DateTime.now.new_offset(0))
+                   format_date_as_iso("end_date", DateTime.now.new_offset(0))
       else
         format_date_as_iso("end_date", end_date)
-      end
+                 end
 
       params = {
         "types" => transaction_types.sort.join(","),
@@ -411,7 +408,7 @@ module SchwabRb
       if return_data_objects
         quotes_data = JSON.parse(response.body, symbolize_names: true)
         quotes_data.map do |symbol, quote_data|
-          SchwabRb::DataObjects::QuoteFactory.build({symbol => quote_data})
+          SchwabRb::DataObjects::QuoteFactory.build({ symbol => quote_data })
         end
       else
         response
@@ -724,12 +721,14 @@ module SchwabRb
       )
     end
 
-    def get_movers(index, sort_order: nil, frequency: nil)
+    def get_movers(index, sort_order: nil, frequency: nil, return_data_objects: true)
       # Get a list of the top ten movers for a given index.
       #
       # @param index [String] Category of mover. See Movers::Index for valid values.
       # @param sort_order [String] Order in which to return values. See Movers::SortOrder for valid values.
-      # @param frequency [String] Only return movers that saw this magnitude or greater. See Movers::Frequency for valid values.
+      # @param frequency [String] Only return movers that saw this magnitude or greater.
+      #   See Movers::Frequency for valid values.
+      # @param return_data_objects [Boolean] Whether to return data objects or raw JSON
       refresh_token_if_needed
 
       index = convert_enum(index, SchwabRb::Movers::Indexes)
@@ -742,7 +741,14 @@ module SchwabRb
       params["sort"] = sort_order if sort_order
       params["frequency"] = frequency.to_s if frequency
 
-      get(path, params)
+      response = get(path, params)
+
+      if return_data_objects
+        movers_data = JSON.parse(response.body, symbolize_names: true)
+        SchwabRb::DataObjects::MarketMoversFactory.build(movers_data)
+      else
+        response
+      end
     end
 
     def get_market_hours(markets, date: nil, return_data_objects: true)

data/lib/schwab_rb/clients/client.rb

@@ -34,8 +34,8 @@ module SchwabRb
       response = session.post(
         dest,
         {
-          :body => data.to_json,
-          :headers => { "Content-Type" => "application/json" }
+          body: data.to_json,
+          headers: { "Content-Type" => "application/json" }
         }
       )
       log_response(response, req_num)
@@ -51,8 +51,8 @@ module SchwabRb
       response = session.put(
         dest,
         {
-          :body => data.to_json,
-          :headers => { "Content-Type" => "application/json" }
+          body: data.to_json,
+          headers: { "Content-Type" => "application/json" }
         }
       )
       log_response(response, req_num)
@@ -73,20 +73,20 @@ module SchwabRb
     def log_request(method, req_num, dest, data = nil)
       redacted_dest = SchwabRb::Redactor.redact_url(dest.to_s)
       SchwabRb::Logger.logger.info("Req #{req_num}: #{method} to #{redacted_dest}")
-      
-      if data
-        redacted_data = SchwabRb::Redactor.redact_data(data)
-        SchwabRb::Logger.logger.debug("Payload: #{JSON.pretty_generate(redacted_data)}")
-      end
+
+      return unless data
+
+      redacted_data = SchwabRb::Redactor.redact_data(data)
+      SchwabRb::Logger.logger.debug("Payload: #{JSON.pretty_generate(redacted_data)}")
     end
 
     def log_response(response, req_num)
       SchwabRb::Logger.logger.info("Resp #{req_num}: Status #{response.status}")
-      
-      if SchwabRb::Logger.logger.level == ::Logger::DEBUG
-        redacted_body = SchwabRb::Redactor.redact_response_body(response)
-        SchwabRb::Logger.logger.debug("Response body: #{JSON.pretty_generate(redacted_body)}") if redacted_body
-      end
+
+      return unless SchwabRb::Logger.logger.level == ::Logger::DEBUG
+
+      redacted_body = SchwabRb::Redactor.redact_response_body(response)
+      SchwabRb::Logger.logger.debug("Response body: #{JSON.pretty_generate(redacted_body)}") if redacted_body
     end
 
     def req_num

data/lib/schwab_rb/configuration.rb

@@ -4,9 +4,9 @@ module SchwabRb
 
     def initialize
       @logger = nil
-      @log_file = ENV['SCHWAB_LOGFILE']
-      @log_level = ENV.fetch('SCHWAB_LOG_LEVEL', 'WARN').upcase
-      @silence_output = ENV.fetch('SCHWAB_SILENCE_OUTPUT', 'false').downcase == 'true'
+      @log_file = ENV.fetch("SCHWAB_LOGFILE", nil)
+      @log_level = ENV.fetch("SCHWAB_LOG_LEVEL", "WARN").upcase
+      @silence_output = ENV.fetch("SCHWAB_SILENCE_OUTPUT", "false").downcase == "true"
     end
 
     def has_external_logger?
@@ -18,7 +18,7 @@ module SchwabRb
     end
 
     def effective_log_file
-      @log_file || (ENV['LOGFILE'] if ENV['LOGFILE'] && !ENV['LOGFILE'].empty?)
+      @log_file || (ENV["LOGFILE"] if ENV["LOGFILE"] && !ENV["LOGFILE"].empty?)
     end
   end
 

data/lib/schwab_rb/data_objects/account.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'instrument'
-require_relative 'position'
+require_relative "instrument"
+require_relative "position"
 
 module SchwabRb
   module DataObjects
@@ -252,7 +252,7 @@ module SchwabRb
             is_day_trader: data.fetch(:isDayTrader),
             is_closing_only_restricted: data.fetch(:isClosingOnlyRestricted),
             pfcb_flag: data.fetch(:pfcbFlag),
-            positions: data.fetch(:positions).map { |position| Position.build(position) },
+            positions: data.fetch(:positions, []).map { |position| Position.build(position) },
             initial_balances: InitialBalances.build(data.fetch(:initialBalances)),
             current_balances: CurrentBalances.build(data.fetch(:currentBalances)),
             projected_balances: ProjectedBalances.build(data.fetch(:projectedBalances))

data/lib/schwab_rb/data_objects/instrument.rb

@@ -132,7 +132,7 @@ module SchwabRb
       end
 
       def option?
-        asset_type == 'OPTION'
+        asset_type == "OPTION"
       end
 
       def to_h

data/lib/schwab_rb/data_objects/market_hours.rb

@@ -33,23 +33,23 @@ module SchwabRb
       end
 
       def equity
-        @markets['equity'] || {}
+        @markets["equity"] || {}
       end
 
       def option
-        @markets['option'] || {}
+        @markets["option"] || {}
       end
 
       def future
-        @markets['future'] || {}
+        @markets["future"] || {}
       end
 
       def forex
-        @markets['forex'] || {}
+        @markets["forex"] || {}
       end
 
       def bond
-        @markets['bond'] || {}
+        @markets["bond"] || {}
       end
 
       def market_types
@@ -63,6 +63,7 @@ module SchwabRb
       def find_market_info(market_type, product_key)
         market_data = find_by_market_type(market_type)
         return nil unless market_data
+
         market_data[product_key.to_s]
       end
 
@@ -102,8 +103,9 @@ module SchwabRb
         !any_open?
       end
 
-      def each_market(&block)
+      def each_market
         return enum_for(:each_market) unless block_given?
+
         @markets.each do |market_type, market_data|
           market_data.each do |product_key, market_info|
             yield(market_type, product_key, market_info)
@@ -121,23 +123,23 @@ module SchwabRb
         attr_reader :date, :market_type, :product, :product_name, :is_open, :session_hours
 
         def initialize(data)
-          @date = data['date']
-          @market_type = data['marketType']
-          @product = data['product']
-          @product_name = data['productName']
-          @is_open = data['isOpen']
-          @session_hours = data['sessionHours'] ? SessionHours.new(data['sessionHours']) : nil
+          @date = data["date"]
+          @market_type = data["marketType"]
+          @product = data["product"]
+          @product_name = data["productName"]
+          @is_open = data["isOpen"]
+          @session_hours = data["sessionHours"] ? SessionHours.new(data["sessionHours"]) : nil
         end
 
         def to_h
           result = {
-            'date' => @date,
-            'marketType' => @market_type,
-            'product' => @product,
-            'isOpen' => @is_open
+            "date" => @date,
+            "marketType" => @market_type,
+            "product" => @product,
+            "isOpen" => @is_open
           }
-          result['productName'] = @product_name if @product_name
-          result['sessionHours'] = @session_hours.to_h if @session_hours
+          result["productName"] = @product_name if @product_name
+          result["sessionHours"] = @session_hours.to_h if @session_hours
           result
         end
 
@@ -159,37 +161,40 @@ module SchwabRb
 
         def regular_market_hours
           return nil unless @session_hours
+
           @session_hours.regular_market
         end
 
         def pre_market_hours
           return nil unless @session_hours
+
           @session_hours.pre_market
         end
 
         def post_market_hours
           return nil unless @session_hours
+
           @session_hours.post_market
         end
 
         def equity?
-          @market_type == 'EQUITY'
+          @market_type == "EQUITY"
         end
 
         def option?
-          @market_type == 'OPTION'
+          @market_type == "OPTION"
         end
 
         def future?
-          @market_type == 'FUTURE'
+          @market_type == "FUTURE"
         end
 
         def forex?
-          @market_type == 'FOREX'
+          @market_type == "FOREX"
         end
 
         def bond?
-          @market_type == 'BOND'
+          @market_type == "BOND"
         end
       end
 
@@ -197,16 +202,16 @@ module SchwabRb
         attr_reader :regular_market, :pre_market, :post_market
 
         def initialize(data)
-          @regular_market = parse_session_periods(data['regularMarket'])
-          @pre_market = parse_session_periods(data['preMarket'])
-          @post_market = parse_session_periods(data['postMarket'])
+          @regular_market = parse_session_periods(data["regularMarket"])
+          @pre_market = parse_session_periods(data["preMarket"])
+          @post_market = parse_session_periods(data["postMarket"])
         end
 
         def to_h
           result = {}
-          result['regularMarket'] = @regular_market.map(&:to_h) if @regular_market
-          result['preMarket'] = @pre_market.map(&:to_h) if @pre_market
-          result['postMarket'] = @post_market.map(&:to_h) if @post_market
+          result["regularMarket"] = @regular_market.map(&:to_h) if @regular_market
+          result["preMarket"] = @pre_market.map(&:to_h) if @pre_market
+          result["postMarket"] = @post_market.map(&:to_h) if @post_market
           result
         end
 
@@ -226,6 +231,7 @@ module SchwabRb
 
         def parse_session_periods(periods_data)
           return nil unless periods_data && periods_data.is_a?(Array)
+
           periods_data.map { |period_data| SessionPeriod.new(period_data) }
         end
       end
@@ -234,14 +240,14 @@ module SchwabRb
         attr_reader :start_time, :end_time
 
         def initialize(data)
-          @start_time = data['start']
-          @end_time = data['end']
+          @start_time = data["start"]
+          @end_time = data["end"]
         end
 
         def to_h
           {
-            'start' => @start_time,
-            'end' => @end_time
+            "start" => @start_time,
+            "end" => @end_time
           }
         end
 
@@ -255,18 +261,22 @@ module SchwabRb
 
         def duration_minutes
           return nil unless @start_time && @end_time
+
           start_obj = start_time_object
           end_obj = end_time_object
           return nil unless start_obj && end_obj
+
           ((end_obj - start_obj) / 60).to_i
         end
 
         def active_now?
           return false unless @start_time && @end_time
+
           now = Time.now
           start_obj = start_time_object
           end_obj = end_time_object
           return false unless start_obj && end_obj
+
           now >= start_obj && now <= end_obj
         end
       end

data/lib/schwab_rb/data_objects/market_movers.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module SchwabRb
+  module DataObjects
+    class MarketMoversFactory
+      def self.build(movers_data)
+        screeners = movers_data[:screeners] || []
+        movers = screeners.map { |screener| Mover.new(screener) }
+        MarketMovers.new(movers)
+      end
+    end
+
+    class MarketMovers
+      attr_reader :movers
+
+      def initialize(movers)
+        @movers = movers
+      end
+
+      def count
+        @movers.size
+      end
+
+      def symbols
+        @movers.map(&:symbol)
+      end
+
+      def find_by_symbol(symbol)
+        @movers.find { |mover| mover.symbol == symbol }
+      end
+
+      def top(num = 5)
+        @movers.first(num)
+      end
+
+      def each(&block)
+        @movers.each(&block)
+      end
+
+      def to_a
+        @movers
+      end
+    end
+
+    class Mover
+      attr_reader :description, :volume, :last_price, :net_change, :market_share,
+                  :total_volume, :trades, :net_percent_change, :symbol
+
+      def initialize(data)
+        @description = data[:description]
+        @volume = data[:volume]
+        @last_price = data[:lastPrice]
+        @net_change = data[:netChange]
+        @market_share = data[:marketShare]
+        @total_volume = data[:totalVolume]
+        @trades = data[:trades]
+        @net_percent_change = data[:netPercentChange]
+        @symbol = data[:symbol]
+      end
+
+      def percentage_of_total_volume
+        return 0.0 if @total_volume.nil? || @total_volume.zero?
+
+        (@volume / @total_volume.to_f) * 100.0
+      end
+
+      def positive_change?
+        @net_change&.positive?
+      end
+
+      def negative_change?
+        @net_change&.negative?
+      end
+
+      def net_change_percentage
+        (@net_percent_change * 100).round(2) if @net_percent_change
+      end
+
+      def to_h
+        {
+          symbol: @symbol,
+          description: @description,
+          volume: @volume,
+          last_price: @last_price,
+          net_change: @net_change,
+          market_share: @market_share,
+          total_volume: @total_volume,
+          trades: @trades,
+          net_percent_change: @net_percent_change
+        }
+      end
+
+      def to_s
+        "<Mover symbol: #{@symbol}, volume: #{@volume}, last_price: #{@last_price}, net_change: #{@net_change}>"
+      end
+    end
+  end
+end

data/lib/schwab_rb/data_objects/option.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'date'
+require "json"
+require "date"
 
 module SchwabRb
   module DataObjects

data/lib/schwab_rb/data_objects/option_chain.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'date'
-require_relative 'option'
+require "json"
+require "date"
+require_relative "option"
 
 module SchwabRb
   module DataObjects
@@ -14,7 +14,7 @@ module SchwabRb
           call_dates = []
           call_opts = []
           data.fetch(:callExpDateMap).each do |exp_date, options|
-            call_dates << Date.strptime(exp_date.to_s.split(':').first, '%Y-%m-%d')
+            call_dates << Date.strptime(exp_date.to_s.split(":").first, "%Y-%m-%d")
             options.each_value do |opts|
               opts.each do |option_data|
                 call_opts << Option.build(underlying_symbol, option_data)
@@ -25,7 +25,7 @@ module SchwabRb
           put_dates = []
           put_opts = []
           data.fetch(:putExpDateMap).each do |exp_date, options|
-            put_dates << Date.strptime(exp_date.to_s.split(':').first, '%Y-%m-%d')
+            put_dates << Date.strptime(exp_date.to_s.split(":").first, "%Y-%m-%d")
 
             options.each_value do |opts|
               opts.each do |option_data|
@@ -83,10 +83,10 @@ module SchwabRb
 
       def to_a(_date = nil)
         call_opts.map do |copt|
-          [copt.expiration_date.strftime('%Y-%m-%d'), copt.put_call, copt.strike, copt.delta, copt.bid, copt.ask,
+          [copt.expiration_date.strftime("%Y-%m-%d"), copt.put_call, copt.strike, copt.delta, copt.bid, copt.ask,
            copt.mark]
         end + put_opts.map do |popt|
-          [popt.expiration_date.strftime('%Y-%m-%d'), popt.put_call, popt.strike, popt.delta, popt.bid, popt.ask,
+          [popt.expiration_date.strftime("%Y-%m-%d"), popt.put_call, popt.strike, popt.delta, popt.bid, popt.ask,
            popt.mark]
         end
       end

data/lib/schwab_rb/data_objects/option_expiration_chain.rb

@@ -12,19 +12,19 @@ module SchwabRb
       end
 
       def initialize(data)
-        @expiration_list = data['expirationList']&.map { |expiration_data| Expiration.new(expiration_data) } || []
-        @status = data['status']
+        @expiration_list = data["expirationList"]&.map { |expiration_data| Expiration.new(expiration_data) } || []
+        @status = data["status"]
       end
 
       def to_h
         {
-          'expirationList' => @expiration_list.map(&:to_h),
-          'status' => @status
+          "expirationList" => @expiration_list.map(&:to_h),
+          "status" => @status
         }
       end
 
       def find_by_date(date)
-        date_str = date.is_a?(Date) ? date.strftime('%Y-%m-%d') : date.to_s
+        date_str = date.is_a?(Date) ? date.strftime("%Y-%m-%d") : date.to_s
         @expiration_list.find { |exp| exp.expiration_date == date_str }
       end
 
@@ -33,15 +33,15 @@ module SchwabRb
       end
 
       def weekly_expirations
-        @expiration_list.select { |exp| exp.expiration_type == 'W' }
+        @expiration_list.select { |exp| exp.expiration_type == "W" }
       end
 
       def monthly_expirations
-        @expiration_list.select { |exp| exp.expiration_type == 'M' }
+        @expiration_list.select { |exp| exp.expiration_type == "M" }
       end
 
       def quarterly_expirations
-        @expiration_list.select { |exp| exp.expiration_type == 'Q' }
+        @expiration_list.select { |exp| exp.expiration_type == "Q" }
       end
 
       def standard_expirations
@@ -64,32 +64,33 @@ module SchwabRb
 
       def each(&block)
         return enum_for(:each) unless block_given?
+
         @expiration_list.each(&block)
       end
 
       include Enumerable
 
       class Expiration
-        attr_reader :expiration_date, :days_to_expiration, :expiration_type, 
+        attr_reader :expiration_date, :days_to_expiration, :expiration_type,
                     :settlement_type, :option_roots, :standard
 
         def initialize(data)
-          @expiration_date = data['expirationDate']
-          @days_to_expiration = data['daysToExpiration']
-          @expiration_type = data['expirationType']
-          @settlement_type = data['settlementType']
-          @option_roots = data['optionRoots']
-          @standard = data['standard']
+          @expiration_date = data["expirationDate"]
+          @days_to_expiration = data["daysToExpiration"]
+          @expiration_type = data["expirationType"]
+          @settlement_type = data["settlementType"]
+          @option_roots = data["optionRoots"]
+          @standard = data["standard"]
         end
 
         def to_h
           {
-            'expirationDate' => @expiration_date,
-            'daysToExpiration' => @days_to_expiration,
-            'expirationType' => @expiration_type,
-            'settlementType' => @settlement_type,
-            'optionRoots' => @option_roots,
-            'standard' => @standard
+            "expirationDate" => @expiration_date,
+            "daysToExpiration" => @days_to_expiration,
+            "expirationType" => @expiration_type,
+            "settlementType" => @settlement_type,
+            "optionRoots" => @option_roots,
+            "standard" => @standard
           }
         end
 
@@ -98,19 +99,19 @@ module SchwabRb
         end
 
         def weekly?
-          @expiration_type == 'W'
+          @expiration_type == "W"
         end
 
         def monthly?
-          @expiration_type == 'M'
+          @expiration_type == "M"
         end
 
         def quarterly?
-          @expiration_type == 'Q'
+          @expiration_type == "Q"
         end
 
         def special?
-          @expiration_type == 'S'
+          @expiration_type == "S"
         end
 
         def date_object