cryptum 0.0.388 → 0.0.392

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a96ddf613cdc94e4883151dd4f6a79e409a0c3fe6b39d8ffc7b8518d3e29215c
-  data.tar.gz: b899801924f9c55990902dbd9977a1b42876d4bc241b6736532d285bc9f078ee
+  metadata.gz: 110c196928530da1a4052a8e6040d4d8059b1aa1468a7da7801e6b9be24e0d51
+  data.tar.gz: 22d185e05a7fc7a365441c3147b481e9cf5aa097c1d857f459ac5302eb3f7a61
 SHA512:
-  metadata.gz: 7809bad411a8b2ff88376b9dde60351a922f8d1668531a1703b3bd7889b6117767e9beafc501b4bd90ba36ba2f5a959c43578f2b253e4a7a3eeb7df9e9c60b61
-  data.tar.gz: e33718bd1a1a52e925e7930d66ce0bfd19ada6510a06a143ef142fe641b2430170a953994a9cf716f35c4bacdbafcaeef34b82126e0eedff1c9fdd398441f64f
+  metadata.gz: 4b67141f9c82d817e68c6ff494af9a40b037114347ac8c26ba8bab339042bd94c0e0372c471636763603ce30ec39a89f57dbe5694e9b374b9d36b9612772d5c9
+  data.tar.gz: 19c5f92b35ca7d11b1fa693aebcc52e6b4dac788ead664b27bf74239f765005b9870229026debde3e900edd53214b91f5be88635ca8e1d4c526eb2cd86ca587f

data/.rubocop_todo.yml

@@ -1,21 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-04-03 17:23:47 UTC using RuboCop version 1.49.0.
+# on 2023-04-03 22:26:52 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: 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.
@@ -30,9 +20,3 @@ Style/ConditionalAssignment:
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantSelf:
-  Exclude:
-    - 'lib/cryptum/api.rb'

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 logging perspective, they can be monitored via:
+From a monitoring perspective, logs can be monitored via:
 ```
-tail -f /tmp/cryptum.log
+$ tail -f /tmp/cryptum.log
 ```
 
 ### **Contributing** ###

data/bin/cryptum

@@ -19,40 +19,22 @@ if option_choice.list_products
   )
 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(
   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
-)
+# Initialize Curses UI
+terminal_win = Cryptum::UI.init(event_history: event_history)
+terminal_win.key_press_event.key_w = true if option_choice.reset_session_countdown
 
 # 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
+# Refresh UI and Trigger Events as Messages via Web Socket are Received.
+# Leverage 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
+  event_history: event_history
 )

data/lib/cryptum/api.rb

@@ -13,7 +13,7 @@ module Cryptum
     require 'cryptum/api/signature'
 
     public_class_method def self.help
-      puts self.constants
+      puts constants.sort
     end
   end
 end

data/lib/cryptum/event.rb

@@ -19,7 +19,7 @@ module Cryptum
     # Display Usage for this Module
 
     public_class_method def self.help
-      constants.sort
+      puts constants.sort
     end
   end
 end

data/lib/cryptum/log.rb

@@ -7,27 +7,31 @@ module Cryptum
     # Cryptum::Log.create(
     # )
     public_class_method def self.append(opts = {})
+      level = opts[:level].to_s.downcase.to_sym
+      msg = opts[:msg]
+      which_self = opts[:which_self].to_s
+      event_history = opts[:event_history]
+
+      # Always append to log file
+      log_file = File.open('/tmp/cryptum.log', 'a')
+
       # Leave 10 "old" log files where
       # each file is ~ 1,024,000 bytes
-      log_file = File.open('/tmp/cryptum.log', 'a')
       logger = Logger.new(
         log_file,
         10,
         1_024_000
       )
-      level = opts[:level].to_s.downcase.to_sym
-      msg = opts[:msg]
-      which_self = opts[:which_self].to_s
-      event_history = opts[:event_history]
 
+      # Only attempt to exit gracefully if level == :error
       exit_gracefully = false
 
       case level
       when :debug
         logger.level = Logger::DEBUG
       when :error
-        logger.level = Logger::ERROR
         exit_gracefully = true
+        logger.level = Logger::ERROR
       when :fatal
         # This is reserved for:
         # Cryptum::UI::Exit
@@ -46,12 +50,16 @@ module Cryptum
       end
 
       logger.datetime_format = '%Y-%m-%d %H:%M:%S.%N'
+      log_event = ''
+      log_event = event_history.order_book[:path] if event_history.respond_to?('order_book')
       if msg.instance_of?(Interrupt)
-        logger.add(logger.level, 'CTRL+C Detected...Ended Session.', which_self)
+        log_event += ' => CTRL+C Detected...Exiting Session.'
       else
-        logger.add(logger.level, msg, which_self)
+        log_event += " => #{msg}"
       end
 
+      logger.add(logger.level, log_event, which_self)
+
       Cryptum::UI::Exit.gracefully(event_history: event_history) if exit_gracefully
     rescue Interrupt, StandardError => e
       raise e

data/lib/cryptum/option/environment.rb

@@ -36,7 +36,9 @@ module Cryptum
 
       # Display Usage for this Module
       public_class_method def self.help
-        constants.sort
+        puts "USAGE:
+          #{self}.get(option_choice: option_choice)
+        "
       end
     end
   end

data/lib/cryptum/option/input_validation.rb

@@ -78,7 +78,9 @@ module Cryptum
 
       # Display Usage for this Module
       public_class_method def self.help
-        constants.sort
+        puts "USAGE:
+          #{self}.check(option_choice: option_choice)
+        "
       end
     end
   end

data/lib/cryptum/option/parser.rb

@@ -76,7 +76,9 @@ module Cryptum
 
       # Display Usage for this Module
       public_class_method def self.help
-        constants.sort
+        puts "USAGE:
+          #{self}.get(option_choice: option_choice)
+        "
       end
     end
   end

data/lib/cryptum/order_book.rb

@@ -10,7 +10,7 @@ module Cryptum
 
     # Display Usage for this Module
     public_class_method def self.help
-      constants.sort
+      puts constants.sort
     end
   end
 end

data/lib/cryptum/portfolio.rb

@@ -7,7 +7,7 @@ module Cryptum
 
     # Display Usage for this Module
     public_class_method def self.help
-      constants.sort
+      puts constants.sort
     end
   end
 end

data/lib/cryptum/ui/exit.rb

@@ -8,6 +8,9 @@ module Cryptum
         event_history = opts[:event_history]
 
         Curses.close_screen
+        msg = event_history.order_book[:path] if event_history.respond_to?('order_book')
+        msg += ' => Session Gracefully Terminated.'
+        Cryptum::Log.append(level: :info, msg: msg, which_self: self)
 
         exit 0
       rescue Interrupt, StandardError => e
@@ -27,7 +30,7 @@ module Cryptum
       # Display a List of Every UI Module
 
       public_class_method def self.help
-        constants.sort
+        puts constants.sort
       end
     end
   end

data/lib/cryptum/ui/key_press_event.rb

@@ -29,7 +29,7 @@ module Cryptum
     # Display a List of Every UI Module
 
     public_class_method def self.help
-      constants.sort
+      puts constants.sort
     end
   end
 end

data/lib/cryptum/ui/order.rb

@@ -14,7 +14,7 @@ module Cryptum
       # Display a List of Every UI Module
 
       public_class_method def self.help
-        constants.sort
+        puts constants.sort
       end
     end
   end

data/lib/cryptum/ui.rb

@@ -16,7 +16,12 @@ module Cryptum
     require 'cryptum/ui/ticker'
 
     # Initialize the UI
-    public_class_method def self.init
+    public_class_method def self.init(opts = {})
+      event_history = opts[:event_history]
+      msg = event_history.order_book[:path] if event_history.respond_to?('order_book')
+      msg += ' => Session Started.'
+      Cryptum::Log.append(level: :info, msg: msg, which_self: self)
+
       # Initialize curses Screen
       Curses.init_screen
 

data/lib/cryptum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cryptum
-  VERSION = '0.0.388'
+  VERSION = '0.0.392'
 end

data/lib/cryptum/web_sock/event_machine.rb

@@ -15,8 +15,16 @@ module Cryptum
         option_choice = opts[:option_choice]
         terminal_win = opts[:terminal_win]
         event_history = opts[:event_history]
-        indicator_status = opts[:indicator_status]
-        bot_conf = opts[:bot_conf]
+
+        # Instantiate Our Status Indicator Objects
+        indicator_status = Cryptum::OrderBook::Indicator.new
+
+        # 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
+        )
 
         max_conn_attempts = 30
         conn_attempt = 0
@@ -49,12 +57,7 @@ module Cryptum
             end
 
             ws.on :message do |event|
-              # TODO: The Speed of the UI is dictated by the
-              # Frequency of WebSocket Messages Coming Through.
-              # Explore another way to decouple required events
-              # (such as keypresses) from only being triggered
-              # when messages come through.
-
+              # Convert Web Socket Response JSON Message to Hash
               event_history.event = JSON.parse(
                 event.data,
                 symbolize_names: true
@@ -73,8 +76,7 @@ module Cryptum
               # Detect Key Press Events
               Cryptum::Event::KeyPress.detect(terminal_win: terminal_win)
 
-              # Cancel ALL Open Orders when
-              # C is pressed
+              # Cancel ALL Open Orders when C is pressed
               if terminal_win.key_press_event.key_c
                 Cryptum::Event::Cancel.open_orders(
                   terminal_win: terminal_win,
@@ -83,8 +85,7 @@ module Cryptum
                 )
               end
 
-              # Get the F* Out (GTFO) when
-              # G is pressed
+              # Get the F* Out (GTFO) when G is pressed
               if terminal_win.key_press_event.key_g
                 event_history = Cryptum::Event::GTFO.now(
                   terminal_win: terminal_win,
@@ -104,8 +105,7 @@ module Cryptum
                 )
               end
 
-              # Only Write Order Book to File when
-              # W is Pressed
+              # Write Order Book to File when W is Pressed
               if terminal_win.key_press_event.key_w
                 Cryptum::Event::OrderBook.write(
                   terminal_win: terminal_win,
@@ -114,7 +114,11 @@ module Cryptum
               end
 
               # Exit if x is Pressed
-              Cryptum::Event::Exit.gracefully(event_history: event_history) if terminal_win.key_press_event.key_x
+              if terminal_win.key_press_event.key_x
+                Cryptum::Event::Exit.gracefully(
+                  event_history: event_history
+                )
+              end
 
               # TAB through Order Plan / Order Execution Window Panes
               if terminal_win.key_press_event.key_tab
@@ -182,9 +186,9 @@ module Cryptum
             end
 
             ws.on :close do
-              # raise when remote peer forces reset...this
-              # is then caught below and reattempts to connect
-              # until conn_attempt > max_conn_attempts
+              # raise Errno::ECONNRESET when remote peer forces reset...
+              # This will be caught in the rescue block below which reattempts
+              # to connect until conn_attempt > max_conn_attempts
               raise Errno::ECONNRESET
             end
 
@@ -211,7 +215,7 @@ module Cryptum
 
             EM.add_periodic_timer(option_choice.market_trend_reset) do
               # NOTE: To ensure the integrity of event_history is maintained,
-              # changes to its contenta _MUST_ stay in thos block.
+              # changes to its contents _MUST_ stay in this block.
               event_history.order_book[:market_trend][:buy] = 0
               event_history.order_book[:market_trend][:sell] = 0
               event_history.order_book[:last_trend_reset] = Time.now.strftime(

data/lib/cryptum/web_sock.rb

@@ -10,7 +10,7 @@ module Cryptum
     # Display Usage for this Module
 
     public_class_method def self.help
-      constants.sort
+      puts constants.sort
     end
   end
 end

data/spec/lib/cryptum/option/environment_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 describe Cryptum::Option::Environment do
   it 'should return data for help method' do
-    help_response = Cryptum::Option::Environment.help
-    expect(help_response).not_to be_nil
+    help_response = Cryptum::Option::Environment
+    expect(help_response).to respond_to :help
   end
 end

data/spec/lib/cryptum/option/input_validation_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 describe Cryptum::Option::InputValidation do
   it 'should return data for help method' do
-    help_response = Cryptum::Option::InputValidation.help
-    expect(help_response).not_to be_nil
+    help_response = Cryptum::Option::InputValidation
+    expect(help_response).to respond_to :help
   end
 end

data/spec/lib/cryptum/option/parser_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 describe Cryptum::Option::Parser do
   it 'should return data for help method' do
-    help_response = Cryptum::Option::Parser.help
-    expect(help_response).not_to be_nil
+    help_response = Cryptum::Option::Parser
+    expect(help_response).to respond_to :help
   end
 end

data/spec/lib/cryptum_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 describe Cryptum do
   it 'should return data for help method' do
-    help_response = Cryptum.help
+    help_response = Cryptum
     expect(help_response).not_to be_nil
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cryptum
 version: !ruby/object:Gem::Version
-  version: 0.0.388
+  version: 0.0.392
 platform: ruby
 authors:
 - 0day Inc.