cryptum 0.0.385 → 0.0.387

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 458a0c463a08f598e1694034fbf077f46a8ba8b263c408fd574b35211c40a69b
-  data.tar.gz: 8b8bf8cf3ff0cd9dfa1ebb3609ad50e6f05d09aea705e726b840060e58d39c32
+  metadata.gz: 0e9169a592ad25d86eeb7b4d34576223135b1e8fda2ad3ec7736761abcfef378
+  data.tar.gz: 6bdec8afaac4ca9664aa84a5c353c2d4e0c6a2f86bbce355ca472b5addde18bc
 SHA512:
-  metadata.gz: 3963c369c745590402ff8943487eb057541b6eae6278cf67992981cbdb0919c847207fcfb43cac8b3cf991b5c1c866adc57035e6106a5715ed7f439ab4e92a8a
-  data.tar.gz: d6abdb55f67bab96545d5207c9d4e995edcbec9d9a85d49b13e01a4a2d4522c5e9b20529460f1b2e20a10dad7f3dc2edfc78376215f85888b2278f5d0131582f
+  metadata.gz: 2d5a4d140e7a16dd90f38f683395f67d6d8ae2c5ccceffb578943552979d59cacadca9479c4b909fa1ac93a98021d17e16f67a1226324707d43cf39274fcad5e
+  data.tar.gz: acd010460f5db7aee817acc3e3d36a0f7196fb5fc0e3be0f530585599375afcb44b4ba5dd25cdd9f3f361b031b483588835b6875d694fe2fe880c437db090745

data/.rubocop_todo.yml

@@ -1,12 +1,22 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-03-31 21:49:04 UTC using RuboCop version 1.48.1.
+# on 2023-04-03 17:23:47 UTC using RuboCop version 1.49.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 7
+# Offense count: 1
+Lint/UnreachableCode:
+  Exclude:
+    - 'bin/cryptum'
+
+# Offense count: 1
+Style/ClassVars:
+  Exclude:
+    - 'bin/cryptum'
+
+# Offense count: 5
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
 # SupportedStyles: assign_to_condition, assign_inside_condition
@@ -15,9 +25,8 @@ Style/ConditionalAssignment:
     - 'lib/cryptum/event/pane.rb'
     - 'lib/cryptum/log.rb'
     - 'lib/cryptum/ui/order/execute_details.rb'
-    - 'lib/cryptum/ui/order_execute_details.rb'
 
-# Offense count: 30
+# Offense count: 28
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false

data/Gemfile

@@ -26,7 +26,7 @@ gem 'rdoc', '6.5.0'
 gem 'require_all', '3.0.0'
 gem 'rest-client', '2.1.0'
 gem 'rspec', '3.12.0'
-gem 'rubocop', '1.48.1'
+gem 'rubocop', '1.49.0'
 gem 'rubocop-rake', '0.6.0'
 gem 'rubocop-rspec', '2.19.0'
 gem 'ruby-prof', '1.6.1'

data/README.md

@@ -108,9 +108,9 @@ If you choose a lower value than the default, the target profit margin's (i.e. T
 
 Another option (particularly useful with smaller balances) is bumping the market trend reset to 604800 (i.e. 1 week) which will immediately increase the TPM %'s.  The downside to this approach is trading volume is reduced, resulting in higher maker & taker fee tiers (i.e. higher cost / trade).
 
-From an error monitoring perspective, they can be monitored via:
+From an logging perspective, they can be monitored via:
 ```
-tail -f /tmp/cryptum-errors.txt
+tail -f /tmp/cryptum.log
 ```
 
 ### **Contributing** ###

data/bin/cryptum

@@ -4,70 +4,57 @@
 
 require 'cryptum'
 
-begin
-  start_time = Time.now.strftime('%Y-%m-%d %H:%M:%S%z')
-  # Initialize Driver Name & Parse cryptum Flags
-  driver_name = File.basename($PROGRAM_NAME)
-  option_choice = Cryptum::Option::Parser.get(driver_name: driver_name)
+start_time = Time.now.strftime('%Y-%m-%d %H:%M:%S%z')
+# Initialize Driver Name & Parse cryptum Flags
+driver_name = File.basename($PROGRAM_NAME)
+option_choice = Cryptum::Option::Parser.get(driver_name: driver_name)
 
-  # Initialize the Respective Environment / API Authentication Artifacts
-  env = Cryptum::Option::Environment.get(option_choice: option_choice)
+# Initialize the Respective Environment / API Authentication Artifacts
+env = Cryptum::Option::Environment.get(option_choice: option_choice)
 
-  # Dump out supported products if --list-products flag is passed and exit
-  if option_choice.list_products
-    Cryptum::API::Products.list_and_exit(
-      option_choice: option_choice,
-      env: env
-    )
-  end
-
-  # Instantiate Our Status Indicators & History Objects
-  indicator_status = Cryptum::OrderBook::Indicator.new
-
-  # Initialize Curses UI
-  terminal_win = Cryptum::UI.init
-
-  # Generate an Order Book for Session Tracking
-  # Load previous order_book_justification from
-  # Order Book File (if it exists)
-  event_history = Cryptum::OrderBook::Generate.new(
-    start_time: start_time,
+# Dump out supported products if --list-products flag is passed and exit
+if option_choice.list_products
+  Cryptum::API::Products.list_and_exit(
     option_choice: option_choice,
     env: env
   )
-  terminal_win.key_press_event.key_w = true if option_choice.reset_session_countdown
-
-  # Automatically Create Bot Confs if they don't
-  # Exist and Initialize Automated Trading Parameters
-  bot_conf = Cryptum::BotConf.read(
-    option_choice: option_choice,
-    event_history: event_history
-  )
-
-  # Connect to WebSocket
-  # Trigger Events as Event Data
-  # Generated via Coinbase Pro
-  # Web Socket HTTP Responses
-  # Refresh UI with Event Data
-  # Update "Status Indicators"
-  # Leverage "Status Indicators" to Initiate Actions
-  Cryptum::WebSock::EventMachine.run(
-    option_choice: option_choice,
-    env: env,
-    terminal_win: terminal_win,
-    event_history: event_history,
-    indicator_status: indicator_status,
-    bot_conf: bot_conf
-  )
-rescue Interrupt
-  # Exit Gracefully if CTRL+C is Pressed During Session
-  Cryptum::UI::Exit.gracefully(
-    which_self: self,
-    event_history: event_history,
-    option_choice: option_choice,
-    env: env
-  )
-rescue StandardError => e
-  # Produce a Stacktrace for anything else
-  raise e
 end
+
+# Instantiate Our Status Indicators & History Objects
+indicator_status = Cryptum::OrderBook::Indicator.new
+
+# Initialize Curses UI
+terminal_win = Cryptum::UI.init
+
+# Generate an Order Book for Session Tracking
+# Load previous order_book_justification from
+# Order Book File (if it exists)
+event_history = Cryptum::OrderBook::Generate.new(
+  start_time: start_time,
+  option_choice: option_choice,
+  env: env
+)
+terminal_win.key_press_event.key_w = true if option_choice.reset_session_countdown
+
+# Automatically Create Bot Confs if they don't
+# Exist and Initialize Automated Trading Parameters
+bot_conf = Cryptum::BotConf.read(
+  option_choice: option_choice,
+  event_history: event_history
+)
+
+# Connect to WebSocket
+# Trigger Events as Event Data
+# Generated via Coinbase Pro
+# Web Socket HTTP Responses
+# Refresh UI with Event Data
+# Update "Status Indicators"
+# Leverage "Status Indicators" to Initiate Actions
+Cryptum::WebSock::EventMachine.run(
+  option_choice: option_choice,
+  env: env,
+  terminal_win: terminal_win,
+  event_history: event_history,
+  indicator_status: indicator_status,
+  bot_conf: bot_conf
+)

data/git_commit.sh

@@ -16,6 +16,7 @@ if [[ $1 != "" && $2 != "" && $3 != "" ]]; then
     this_version=`ruby -r 'cryptum' -e 'print Cryptum::VERSION'`
     echo "Tagging: ${this_version}"
     git tag $this_version
+    git push origin $this_version
   fi
 else
   echo "USAGE: ${0} '<full name>' <email address> '<git commit comments>'"

data/lib/cryptum/api/exchange_rates.rb

@@ -22,8 +22,8 @@ module Cryptum
           api_endpoint: api_endpoint,
           api_call: exchange_rates_api_call
         )
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self)
       end
 
       # Display Usage for this Module

data/lib/cryptum/api/fees.rb

@@ -18,8 +18,8 @@ module Cryptum
           http_method: :GET,
           api_call: fees_api_call
         )
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self)
       end
 
       # Display Usage for this Module

data/lib/cryptum/api/order_history.rb

@@ -39,8 +39,8 @@ module Cryptum
         end
 
         order_history
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self)
       end
 
       # Display Usage for this Module

data/lib/cryptum/api/orders.rb

@@ -83,8 +83,8 @@ module Cryptum
         end
 
         event_history
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)
       end
 
       # public_class_method def self.cancel_open_order(opts = {})
@@ -104,8 +104,8 @@ module Cryptum
       #     params: params,
       #     order_type: order_type
       #   )
-      # rescue StandardError => e
-      #   raise e
+      # rescue Interrupt, StandardError => e
+      #   Cryptum::Log.append(level: :error, msg: e, which_self: self)
       # end
 
       public_class_method def self.cancel_all_open_orders(opts = {})
@@ -135,8 +135,8 @@ module Cryptum
           break if canceled_order_id_arr.empty?
         end
         canceled_order_id_arr
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self)
       end
 
       public_class_method def self.gtfo(opts = {})
@@ -231,8 +231,8 @@ module Cryptum
         event_history.order_book[:order_history_meta].push(this_order)
 
         event_history
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)
       end
 
       public_class_method def self.help

data/lib/cryptum/api/portfolio.rb

@@ -59,8 +59,8 @@ module Cryptum
         )
 
         crypto_portfolio
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self)
       end
 
       # Display Usage for this Module

data/lib/cryptum/api/products.rb

@@ -27,8 +27,8 @@ module Cryptum
         end
 
         sorted_products
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self)
       end
 
       # List Supported Cryptum Products and Exit
@@ -47,8 +47,8 @@ module Cryptum
         end
 
         exit 0
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self)
       end
 
       # Display Usage for this Module

data/lib/cryptum/api/rest.rb

@@ -116,33 +116,32 @@ module Cryptum
             )
 
           else
-            File.open('/tmp/cryptum-errors.txt', 'a') do |f|
-              f.puts "Unsupported HTTP Method #{http_method} for #{self} Plugin"
-            end
+            e = "Unsupported HTTP Method #{http_method}"
+            Cryptum::Log.append(level: :debug, msg: e, which_self: self)
           end
 
           resp = JSON.parse(response, symbolize_names: true)
           resp ||= []
         rescue RestClient::Unauthorized => e
-          File.open('/tmp/cryptum-errors.txt', 'a') do |f|
-            f.puts Time.now.strftime('%Y-%m-%d %H:%M:%S.%N %z')
-            f.puts "#{self}\n#{e}\n\n\n"
-          end
+          Cryptum::Log.append(level: :debug, msg: e, which_self: self)
 
-          raise e if conn_attempt > max_conn_attempts
+          if conn_attempt > max_conn_attempts
+            Cryptum::Log.append(
+              level: :error,
+              msg: e,
+              which_self: self
+            )
+          end
 
           sleep 60
           retry
         end
       rescue RestClient::ExceptionWithResponse => e
-        File.open('/tmp/cryptum-errors.txt', 'a') do |f|
-          f.puts Time.now.strftime('%Y-%m-%d %H:%M:%S.%N %z')
-          f.puts "Module: #{self}"
-          f.puts "URL: #{api_endpoint}#{api_call}"
-          f.puts "PARAMS: #{params.inspect}"
-          f.puts "HTTP POST BODY: #{http_body.inspect}" if http_body != ''
-          f.puts "#{e}\n#{e.response}\n\n\n"
-        end
+        debug = "URL: #{api_endpoint}#{api_call}"
+        debug += "PARAMS: #{params.inspect}"
+        debug += "HTTP POST BODY: #{http_body.inspect}" if http_body != ''
+        debug += "#{e}\n#{e.response}\n\n\n"
+        Cryptum::Log.append(level: :debug, msg: debug, which_self: self)
 
         insufficient_funds = '{"message":"Insufficient funds"}'
         size -= base_increment if e.response == insufficient_funds
@@ -150,17 +149,16 @@ module Cryptum
         sleep 0.3
         retry
       rescue RestClient::TooManyRequests => e
-        File.open('/tmp/cryptum-errors.txt', 'a') do |f|
-          f.puts Time.now.strftime('%Y-%m-%d %H:%M:%S.%N %z')
-          f.puts "Module: #{self}"
-          f.puts "URL: #{api_endpoint}#{api_call}"
-          f.puts "PARAMS: #{params.inspect}"
-          f.puts "HTTP POST BODY: #{http_body.inspect}" if http_body != ''
-          f.puts "#{e}\n#{e.response}\n\n\n"
-        end
+        debug = "URL: #{api_endpoint}#{api_call}"
+        debug += "PARAMS: #{params.inspect}"
+        debug += "HTTP POST BODY: #{http_body.inspect}" if http_body != ''
+        debug += "#{e}\n#{e.response}\n\n\n"
+        Cryptum::Log.append(level: :debug, msg: debug, which_self: self)
 
         sleep 1
         retry
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: error, msg: e, which_self: self)
       end
 
       # Display Usage for this Module

data/lib/cryptum/api/signature.rb

@@ -54,8 +54,8 @@ module Cryptum
         api_signature_response[:api_signature] = api_signature
 
         api_signature_response
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self)
       end
 
       # Display Usage for this Module

data/lib/cryptum/bot_conf.rb

@@ -41,17 +41,9 @@ module Cryptum
       end
 
       retry
-    rescue Interrupt
-      # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum::UI::Exit.gracefully(
-        which_self: self,
-        event_history: event_history,
-        option_choice: option_choice
-      )
-    rescue StandardError => e
+    rescue Interrupt, StandardError => e
       # Produce a Stacktrace for anything else
-      Curses.close_screen
-      raise e
+      Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)
     end
 
     # SAUCE 1
@@ -148,22 +140,15 @@ module Cryptum
       end
 
       retry
-    rescue Interrupt
-      # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum::UI::Exit.gracefully(
-        which_self: self,
-        event_history: event_history,
-        option_choice: option_choice
-      )
-    rescue StandardError => e
+    rescue Interrupt, StandardError => e
       # Produce a Stacktrace for anything else
-      Curses.close_screen
-      raise e
+      Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)
     end
 
     # Update Key/Value Pair in Bot Conf and Serialize to YAML File
     public_class_method def self.update(opts = {})
       option_choice = opts[:option_choice]
+      event_history = opts[:event_history]
       bot_conf = opts[:bot_conf]
       key = opts[:key].to_s.to_sym
       value = opts[:value]
@@ -182,16 +167,9 @@ module Cryptum
       end
 
       retry
-    rescue Interrupt
-      # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum::UI::Exit.gracefully(
-        which_self: self,
-        option_choice: option_choice
-      )
-    rescue StandardError => e
+    rescue Interrupt, StandardError => e
       # Produce a Stacktrace for anything else
-      Curses.close_screen
-      raise e
+      Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)
     end
 
     # Display Usage for this Module

data/lib/cryptum/event/bot_conf.rb

@@ -19,8 +19,8 @@ module Cryptum
           option_choice: option_choice,
           event_history: event_history
         )
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)
       end
 
       # Display Usage for this Module

data/lib/cryptum/event/buy.rb

@@ -26,8 +26,8 @@ module Cryptum
           event_history: event_history,
           bot_conf: bot_conf
         )
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)
       end
 
       # Display Usage for this Module

data/lib/cryptum/event/cancel.rb

@@ -11,17 +11,14 @@ module Cryptum
         terminal_win = opts[:terminal_win]
         option_choice = opts[:option_choice]
         env = opts[:env]
-        # event_history = opts[:event_history]
-        # order_type = opts[:order_type]
-        # order_action = opts[:order_action]
 
         terminal_win.key_press_event.key_c = false
         Cryptum::API::Orders.cancel_all_open_orders(
           env: env,
           option_choice: option_choice
         )
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self)
       end
 
       # Display Usage for this Module

data/lib/cryptum/event/exit.rb

@@ -8,20 +8,11 @@ module Cryptum
       # Cryptum::Event::Exit.gracefully(
       # )
       public_class_method def self.gracefully(opts = {})
-        terminal_win = opts[:terminal_win]
         event_history = opts[:event_history]
-        option_choice = opts[:option_choice]
-        env = opts[:env]
 
-        terminal_win.key_press_event.key_x = false
-        Cryptum::UI::Exit.gracefully(
-          which_self: self,
-          event_history: event_history,
-          option_choice: option_choice,
-          env: env
-        )
-      rescue StandardError => e
-        raise e
+        Cryptum::UI::Exit.gracefully(event_history: event_history)
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)
       end
 
       # Display Usage for this Module

data/lib/cryptum/event/gtfo.rb

@@ -21,8 +21,8 @@ module Cryptum
           event_history: event_history,
           bot_conf: bot_conf
         )
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)
       end
 
       # Display Usage for this Module

data/lib/cryptum/event/history.rb

@@ -193,15 +193,9 @@ module Cryptum
         end
         # -------------------------------------------------- #
       end
-    rescue Interrupt
-      # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum::UI::Exit.gracefully(
-        which_self: self,
-        option_choice: option_choice
-      )
-    rescue StandardError => e
+    rescue Interrupt, StandardError => e
       # Produce a Stacktrace for anything else
-      raise e
+      Cryptum::Log.append(level: :error, msg: e, which_self: self)
     end
   end
 end

data/lib/cryptum/event/key_press.rb

@@ -49,8 +49,8 @@ module Cryptum
           key_press_event: terminal_win.key_press_event,
           ui_win: terminal_win.command_section
         )
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self)
       end
 
       # Display Usage for this Module

data/lib/cryptum/event/order_book.rb

@@ -19,8 +19,8 @@ module Cryptum
           order_book_file,
           JSON.pretty_generate(event_history.order_book)
         )
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)
       end
 
       # Display Usage for this Module

data/lib/cryptum/event/pane.rb

@@ -21,8 +21,8 @@ module Cryptum
           event_history.order_plan_win_active = true
           event_history.order_execute_win_active = false
         end
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self)
       end
 
       # Supported Method Parameters::
@@ -49,8 +49,8 @@ module Cryptum
             event_history.order_execute_details_win_active = true
           end
         end
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)
       end
 
       # Display Usage for this Module

data/lib/cryptum/event/parse.rb

@@ -150,16 +150,8 @@ module Cryptum
         )
 
         event_history
-      rescue Interrupt
-        # Exit Gracefully if CTRL+C is Pressed During Session
-        Cryptum::UI::Exit.gracefully(
-          which_self: self,
-          event_history: event_history,
-          option_choice: option_choice,
-          env: env
-        )
-      rescue StandardError => e
-        raise e
+      rescue Interrupt, StandardError => e
+        Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)
       end
 
       # Display Usage for this Module