cryptum 0.0.379 → 0.0.380

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 267109002234d04e788a39303868e372163535eb908e5934bd19e6765f552ed4
-  data.tar.gz: e5c9e401567e65691048b8c8131c39447202ce5ab5dfacfcd07d9fd5e0a4be7a
+  metadata.gz: 2c3982c00e3f216242d2e27886cd5896804f3605d540394c6961d0d5c1bc38db
+  data.tar.gz: d346e20098bcb5488d4a0a5067b8004ddf26674e8d181fa24676d10a80dda370
 SHA512:
-  metadata.gz: 067a56f54d073b4d05d52d15cc06be7f5c91b58ccc6c5d0cb9a8f6da7ff1c57b9296772aedabc532a11dd30f2ef02489dd97b7fbb8038193fcfa805a3f58cc8e
-  data.tar.gz: adda615b995b857cbe39ad49eeeb04307c3478c310a93e7fee25ae2d5f164bf9748db6cc0036e864eb9ea2c553b0a5741079f2007d09599170fb82ce07a31d30
+  metadata.gz: 6b4b4cbb7db373840040049d056bcfb58fa0ead62230cefb8953d4573b29043f343f3eee2ac23166806a212de26d2a4aa59ea39cc94959c41e315ac2df2280e7
+  data.tar.gz: 18951472ce501e7f80332fd531e9f7dc70483af3d11b0efce8ee117d86b47dbb8848c52e0c6fc27e5fe13ced953c8ec4fb5487333368032c395776160d1bddcd

data/.rubocop.yml

@@ -5,6 +5,8 @@ Layout:
   Max: 3000
 Layout/LineLength:
   Max: 256
+Lint/UselessRescue:
+  Enabled: false
 Metrics/AbcSize:
   Max: 512
 Metrics/BlockLength:

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-03-29 14:29:26 UTC using RuboCop version 1.48.1.
+# on 2023-03-30 21:02:59 UTC using RuboCop version 1.48.1.
 # 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
@@ -11,10 +11,6 @@ Lint/UselessAssignment:
   Exclude:
     - 'lib/cryptum/api.rb'
 
-# Offense count: 58
-Lint/UselessRescue:
-  Enabled: false
-
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:

data/bin/cryptum

@@ -8,14 +8,14 @@ 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(driver_name: driver_name)
+  option_choice = Cryptum::Option::Parser.get(driver_name: driver_name)
 
   # Initialize the Respective Environment / API Authentication Artifacts
-  env = Cryptum::Option.get_env(option_choice: option_choice)
+  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::Option.list_products_and_exit(
+    Cryptum::API.list_products_and_exit(
       option_choice: option_choice,
       env: env
     )

data/bin/cryptum-forecast

@@ -113,7 +113,7 @@ begin
   autotrade_cycle_tot = 1 unless option_choice.cycles_complete.to_i.positive?
 
   # Initialize the Respective Environment / API Authentication Artifacts
-  env = Cryptum::Option.get_env(option_choice: option_choice)
+  env = Cryptum::Option::Environment.get(option_choice: option_choice)
 
   # Read in Bot Conf Values
   bot_conf = Cryptum::BotConf.read(option_choice: option_choice)

data/lib/cryptum/api.rb

@@ -488,6 +488,26 @@ module Cryptum
       raise e
     end
 
+    # List Supported Cryptum Products and Exit
+    public_class_method def self.list_products_and_exit(opts = {})
+      option_choice = opts[:option_choice]
+      env = opts[:env]
+
+      puts "\n#{option_choice.driver_name} Supports the Following Products:"
+      products = Cryptum::API.get_products(
+        option_choice: option_choice,
+        env: env
+      )
+
+      products.map do |product|
+        puts product[:id].downcase
+      end
+
+      exit 0
+    rescue StandardError => e
+      raise e
+    end
+
     private_class_method def self.get_exchange_rates(opts = {})
       option_choice = opts[:option_choice]
       env = opts[:env]
@@ -668,19 +688,19 @@ module Cryptum
        )
 
        profiles = #{self}.get_profiles(
-         env: 'required - Coinbase::Option.get_env Object'
+         env: 'required - Coinbase::Option::Environment.get Object'
        )
 
        products = #{self}.get_products(
-         env: 'required - Coinbase::Option.get_env Object'
+         env: 'required - Coinbase::Option::Environment.get Object'
        )
 
        portfolio = #{self}.get_portfolio(
-         env: 'required - Coinbase::Option.get_env Object'
+         env: 'required - Coinbase::Option::Environment.get Object'
        )
 
        order_history = #{self}.get_order_history(
-         env: 'required - Coinbase::Option.get_env Object'
+         env: 'required - Coinbase::Option::Environment.get Object'
        )
       "
     end

data/lib/cryptum/option/choice.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Cancel Open Limit Orders
+  # This module is used to Accept User Input at Session Initiation
   module Option
-    # Keep Last Event History When Terminal Resize Occuers
+    # attr_accessor objects to pass through application
     class Choice
       attr_accessor :autotrade,
                     :driver_name,

data/lib/cryptum/option/environment.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Cryptum
+  # This module is used to Accept User Input at Session Initiation
+  module Option
+    # Common module to consume YAML config and determine which environment to use.
+    module Environment
+      # Initialize Cryptum Session Environment
+      public_class_method def self.get(opts = {})
+        option_choice = opts[:option_choice]
+
+        yaml_conf_file = "#{option_choice.session_root}/etc/coinbase_pro.yaml"
+        yaml_conf = YAML.load_file(
+          yaml_conf_file,
+          symbolize_names: true
+        )
+
+        env = yaml_conf[:prod]
+        env[:env] = :prod
+        env = yaml_conf[:sandbox] if option_choice.sandbox
+        env[:env] = :sandbox if option_choice.sandbox
+
+        open_ai_yaml_conf_file = "#{option_choice.session_root}/etc/open_ai.yaml"
+        if File.exist?(open_ai_yaml_conf_file)
+          open_ai_yaml_conf = YAML.load_file(
+            open_ai_yaml_conf_file,
+            symbolize_names: true
+          )
+          env[:open_ai_bearer_token] = open_ai_yaml_conf[:bearer_token]
+        end
+
+        env
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        constants.sort
+      end
+    end
+  end
+end

data/lib/cryptum/option/input_validation.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This module is used to Accept User Input at Session Initiation
+  module Option
+    # Common module to validate input submitted at session initiation
+    module InputValidation
+      # Validate Options for cryptum Driver
+      public_class_method def self.check(opts = {})
+        option_choice = opts[:option_choice]
+
+        # Conditions to display cryptum usage
+        if option_choice.symbol.nil? && option_choice.list_products.nil?
+          usage = true
+          reason = :symbol
+        end
+
+        option_choice.session_root = "#{Dir.home}/cryptum" if option_choice.session_root.nil?
+
+        unless Dir.exist?(option_choice.session_root)
+          usage = true
+          reason = :session_root
+        end
+
+        option_choice.market_trend_reset = 86_400 if option_choice.market_trend_reset.to_i.zero?
+        unless option_choice.market_trend_reset.to_i >= 60 &&
+               option_choice.market_trend_reset <= 604_800
+          usage = true
+          reason = :market_trend_reset
+        end
+
+        case option_choice.market_trend_reset
+        when 604_800
+          option_choice.market_trend_reset_label = '1W'
+        when 86_400
+          option_choice.market_trend_reset_label = '1D'
+        when 14_400
+          option_choice.market_trend_reset_label = '4h'
+        when 10_800
+          option_choice.market_trend_reset_label = '3h'
+        when 7_200
+          option_choice.market_trend_reset_label = '2h'
+        when 3_600
+          option_choice.market_trend_reset_label = '1h'
+        when 2_700
+          option_choice.market_trend_reset_label = '45m'
+        when 1_800
+          option_choice.market_trend_reset_label = '30m'
+        when 900
+          option_choice.market_trend_reset_label = '15m'
+        when 300
+          option_choice.market_trend_reset_label = '5m'
+        when 180
+          option_choice.market_trend_reset_label = '3m'
+        when 60
+          option_choice.market_trend_reset_label = '1m'
+        else
+          usage = true
+          reason = :market_trend_reset
+        end
+
+        if usage
+          case reason
+          when :symbol
+            puts "ERROR: --symbol Flag is Required.\n\n"
+          when :session_root
+            puts "ERROR: #{option_choice.session_root} does not exist.\n\n"
+          when :market_trend_reset
+            puts "ERROR: #{option_choice.market_trend_reset} - Possible values are: 604_800 || 86_400 || 14_400 || 10_800 || 7_200 || 3_600 || 2_700 || 1_800 || 900 || 300 || 180 || 60\n\n"
+          end
+
+          puts `#{option_choice.driver_name} --help`
+          exit 1
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        constants.sort
+      end
+    end
+  end
+end

data/lib/cryptum/option/parser.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module Cryptum
+  # This module is used to Accept User Input at Session Initiation
+  module Option
+    # Common module to consume YAML config and determine which environment to use.
+    module Parser
+      # Parse Options Passed to cryptum
+      public_class_method def self.get(opts = {})
+        option_choice = Cryptum::Option::Choice.new
+        option_choice.driver_name = opts[:driver_name]
+
+        OptionParser.new do |options|
+          options.banner = "USAGE: #{option_choice.driver_name} [opts]"
+
+          options.on(
+            '-sSYMBOL',
+            '--symbol=SYMBOL',
+            '<Required - Crypto Symbol.(e.g. btc-usd, eth-usd, etc.)'
+          ) { |s| option_choice.symbol = s.to_s.gsub('-', '_').downcase.to_sym }
+
+          options.on(
+            '-A',
+            '--[no-]autotrade',
+            '<Optional - Automatically Buy and Sell Crypto>'
+          ) { |a| option_choice.autotrade = a }
+
+          options.on(
+            '-l',
+            '--[no-]list-products',
+            '<Optional - List Supported Crypto Currency Products and Exit>'
+          ) { |l| option_choice.list_products = l }
+
+          options.on(
+            '-pPROXY',
+            '--proxy=PROXY',
+            '<Optional - HTTP Proxy e.g. "http://127.0.0.1:8080">'
+          ) { |p| option_choice.proxy = p }
+
+          options.on(
+            '-R',
+            '--[no-]reset-trend-countdown',
+            '<Optional - Reset Market Trend Countdown at Session Init (Defaults to false)>'
+          ) { |t| option_choice.reset_session_countdown = t }
+
+          options.on(
+            '-rPATH',
+            '--session-root=PATH',
+            '<Optional - Directory with etc && order_books (Defaults to ~/cryptum)>'
+          ) { |r| option_choice.session_root = r }
+
+          options.on(
+            '-S',
+            '--[no-]sandbox',
+            '<Optional - Use Coinbase Sandbox Environment for Testing Ideas>'
+          ) { |n| option_choice.sandbox = n }
+
+          options.on(
+            '-tSECONDS',
+            '--trend-reset-time=SECONDS',
+            '<Optional - Seconds Between Market Trend Reset (Default 86_400 i.e. 1 day)>'
+          ) { |t| option_choice.market_trend_reset = t.to_i }
+        end.parse!
+
+        Cryptum::Option::InputValidation.check(option_choice: option_choice)
+
+        option_choice
+      rescue OptionParser::InvalidOption => e
+        # Print Usage if unsupported flags are passed
+        puts "ERROR: #{e.message}\n\n"
+        puts `#{option_choice.driver_name} --help`
+        exit 1
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        constants.sort
+      end
+    end
+  end
+end

data/lib/cryptum/option.rb

@@ -1,202 +1,13 @@
 # frozen_string_literal: true
 
-require 'optparse'
-require 'yaml'
-
 module Cryptum
   # Cryptum::UI Module used for Presenting the
   # Cryptum Curses Interface
   module Option
     require 'cryptum/option/choice'
-
-    # Options for cryptum Driver
-    public_class_method def self.parser(opts = {})
-      option_choice = Option::Choice.new
-      option_choice.driver_name = opts[:driver_name]
-
-      OptionParser.new do |options|
-        options.banner = "USAGE: #{option_choice.driver_name} [opts]"
-
-        options.on(
-          '-sSYMBOL',
-          '--symbol=SYMBOL',
-          '<Required - Crypto Symbol.(e.g. btc-usd, eth-usd, etc.)'
-        ) { |s| option_choice.symbol = s.to_s.gsub('-', '_').downcase.to_sym }
-
-        options.on(
-          '-A',
-          '--[no-]autotrade',
-          '<Optional - Automatically Buy and Sell Crypto>'
-        ) { |a| option_choice.autotrade = a }
-
-        options.on(
-          '-l',
-          '--[no-]list-products',
-          '<Optional - List Supported Crypto Currency Products and Exit>'
-        ) { |l| option_choice.list_products = l }
-
-        options.on(
-          '-pPROXY',
-          '--proxy=PROXY',
-          '<Optional - HTTP Proxy e.g. "http://127.0.0.1:8080">'
-        ) { |p| option_choice.proxy = p }
-
-        options.on(
-          '-R',
-          '--[no-]reset-trend-countdown',
-          '<Optional - Reset Market Trend Countdown at Session Init (Defaults to false)>'
-        ) { |t| option_choice.reset_session_countdown = t }
-
-        options.on(
-          '-rPATH',
-          '--session-root=PATH',
-          '<Optional - Directory with etc && order_books (Defaults to ~/cryptum)>'
-        ) { |r| option_choice.session_root = r }
-
-        options.on(
-          '-S',
-          '--[no-]sandbox',
-          '<Optional - Use Coinbase Sandbox Environment for Testing Ideas>'
-        ) { |n| option_choice.sandbox = n }
-
-        options.on(
-          '-tSECONDS',
-          '--trend-reset-time=SECONDS',
-          '<Optional - Seconds Between Market Trend Reset (Default 86_400 i.e. 1 day)>'
-        ) { |t| option_choice.market_trend_reset = t.to_i }
-      end.parse!
-
-      input_validation(option_choice: option_choice)
-
-      option_choice
-    rescue OptionParser::InvalidOption => e
-      # Print Usage if unsupported flags are passed
-      puts "ERROR: #{e.message}\n\n"
-      puts `#{option_choice.driver_name} --help`
-      exit 1
-    rescue StandardError => e
-      raise e
-    end
-
-    # Validate Options for cryptum Driver
-    public_class_method def self.input_validation(opts = {})
-      option_choice = opts[:option_choice]
-
-      # Conditions to display cryptum usage
-      if option_choice.symbol.nil? && option_choice.list_products.nil?
-        usage = true
-        reason = :symbol
-      end
-
-      option_choice.session_root = "#{Dir.home}/cryptum" if option_choice.session_root.nil?
-
-      unless Dir.exist?(option_choice.session_root)
-        usage = true
-        reason = :session_root
-      end
-
-      option_choice.market_trend_reset = 86_400 if option_choice.market_trend_reset.to_i.zero?
-      unless option_choice.market_trend_reset.to_i >= 60 &&
-             option_choice.market_trend_reset <= 604_800
-        usage = true
-        reason = :market_trend_reset
-      end
-
-      case option_choice.market_trend_reset
-      when 604_800
-        option_choice.market_trend_reset_label = '1W'
-      when 86_400
-        option_choice.market_trend_reset_label = '1D'
-      when 14_400
-        option_choice.market_trend_reset_label = '4h'
-      when 10_800
-        option_choice.market_trend_reset_label = '3h'
-      when 7_200
-        option_choice.market_trend_reset_label = '2h'
-      when 3_600
-        option_choice.market_trend_reset_label = '1h'
-      when 2_700
-        option_choice.market_trend_reset_label = '45m'
-      when 1_800
-        option_choice.market_trend_reset_label = '30m'
-      when 900
-        option_choice.market_trend_reset_label = '15m'
-      when 300
-        option_choice.market_trend_reset_label = '5m'
-      when 180
-        option_choice.market_trend_reset_label = '3m'
-      when 60
-        option_choice.market_trend_reset_label = '1m'
-      else
-        usage = true
-        reason = :market_trend_reset
-      end
-
-      if usage
-        case reason
-        when :symbol
-          puts "ERROR: --symbol Flag is Required.\n\n"
-        when :session_root
-          puts "ERROR: #{option_choice.session_root} does not exist.\n\n"
-        when :market_trend_reset
-          puts "ERROR: #{option_choice.market_trend_reset} - Possible values are: 604_800 || 86_400 || 14_400 || 10_800 || 7_200 || 3_600 || 2_700 || 1_800 || 900 || 300 || 180 || 60\n\n"
-        end
-
-        puts `#{option_choice.driver_name} --help`
-        exit 1
-      end
-    rescue StandardError => e
-      raise e
-    end
-
-    # List Supported Cryptum Products and Exit
-    public_class_method def self.list_products_and_exit(opts = {})
-      option_choice = opts[:option_choice]
-      env = opts[:env]
-
-      puts "\n#{option_choice.driver_name} Supports the Following Products:"
-      products = Cryptum::API.get_products(
-        option_choice: option_choice,
-        env: env
-      )
-
-      products.map do |product|
-        puts product[:id].downcase
-      end
-
-      exit 0
-    rescue StandardError => e
-      raise e
-    end
-
-    # Initialize Cryptum Session Environment
-    public_class_method def self.get_env(opts = {})
-      option_choice = opts[:option_choice]
-
-      yaml_conf_file = "#{option_choice.session_root}/etc/coinbase_pro.yaml"
-      yaml_conf = YAML.load_file(
-        yaml_conf_file,
-        symbolize_names: true
-      )
-
-      env = yaml_conf[:prod]
-      env[:env] = :prod
-      env = yaml_conf[:sandbox] if option_choice.sandbox
-      env[:env] = :sandbox if option_choice.sandbox
-
-      open_ai_yaml_conf_file = "#{option_choice.session_root}/etc/open_ai.yaml"
-      if File.exist?(open_ai_yaml_conf_file)
-        open_ai_yaml_conf = YAML.load_file(
-          open_ai_yaml_conf_file,
-          symbolize_names: true
-        )
-        env[:open_ai_bearer_token] = open_ai_yaml_conf[:bearer_token]
-      end
-
-      env
-    rescue StandardError => e
-      raise e
-    end
+    require 'cryptum/option/environment'
+    require 'cryptum/option/input_validation'
+    require 'cryptum/option/parser'
 
     # Display a List of Every UI Module
     public_class_method def self.help

data/lib/cryptum/version.rb

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

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+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
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+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
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+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
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptum
 version: !ruby/object:Gem::Version
-  version: 0.0.379
+  version: 0.0.380
 platform: ruby
 authors:
 - 0day Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-29 00:00:00.000000000 Z
+date: 2023-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -427,6 +427,9 @@ files:
 - lib/cryptum/open_ai.rb
 - lib/cryptum/option.rb
 - lib/cryptum/option/choice.rb
+- lib/cryptum/option/environment.rb
+- lib/cryptum/option/input_validation.rb
+- lib/cryptum/option/parser.rb
 - lib/cryptum/order_book.rb
 - lib/cryptum/order_book/generate.rb
 - lib/cryptum/order_book/indicator.rb
@@ -472,6 +475,9 @@ files:
 - spec/lib/cryptum/matrix_spec.rb
 - spec/lib/cryptum/open_ai_spec.rb
 - spec/lib/cryptum/option/choice_spec.rb
+- spec/lib/cryptum/option/environment_spec.rb
+- spec/lib/cryptum/option/input_validation_spec.rb
+- spec/lib/cryptum/option/parser_spec.rb
 - spec/lib/cryptum/option_spec.rb
 - spec/lib/cryptum/order_book/generate_spec.rb
 - spec/lib/cryptum/order_book/indicator_spec.rb