cryptum 0.0.379 → 0.0.381

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/order_book/generate.rb

@@ -25,7 +25,7 @@ module Cryptum
         order_book_file = "#{session_root}/order_books/#{symbol}.ORDER_BOOK.json"
 
         # Only need to retrieve a product list once / session.
-        products = Cryptum::API.get_products(
+        products = Cryptum::API::Products.get(
           option_choice: option_choice,
           env: env
         )

data/lib/cryptum/portfolio/balance.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'logger'
-
 module Cryptum
   # This plugin is used to instantiate a Cryptum logger with a custom message format
   module Portfolio
@@ -64,7 +62,7 @@ module Cryptum
           enotes = "{ \"event_type\": \"#{etype}\", \"cancel\": \"#{ocancel}\", \"submitted\": \"#{osubmit}\" }" if option_choice.proxy
           event_history.event_notes = enotes
 
-          portfolio = Cryptum::API.get_portfolio(
+          portfolio = Cryptum::API::Portfolio.get(
             option_choice: option_choice,
             env: env,
             crypto: crypto,
@@ -74,13 +72,13 @@ module Cryptum
           )
           event_history.order_book[:portfolio] = portfolio unless portfolio.empty?
 
-          order_history = Cryptum::API.get_order_history(
+          order_history = Cryptum::API::OrderHistory.get(
             option_choice: option_choice,
             env: env
           )
           event_history.order_book[:order_history] = order_history unless order_history.empty?
 
-          fees = Cryptum::API.get_fees(
+          fees = Cryptum::API::Fees.get(
             option_choice: option_choice,
             env: env
           )

data/lib/cryptum/ui/order_execution.rb

@@ -127,7 +127,7 @@ module Cryptum
               event_history.red_pill = true if fiat_invested_this_order > fiat_avail_to_trade.to_f
 
               unless event_history.red_pill
-                event_history = Cryptum::API.submit_limit_order(
+                event_history = Cryptum::API::Orders.submit_limit_order(
                   option_choice: option_choice,
                   env: env,
                   price: price,
@@ -253,7 +253,7 @@ module Cryptum
 
               size = order_ready_to_sell[:size]
 
-              Cryptum::API.submit_limit_order(
+              Cryptum::API::Orders.submit_limit_order(
                 option_choice: option_choice,
                 env: env,
                 price: price,

data/lib/cryptum/version.rb

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

data/lib/cryptum/web_sock/coinbase.rb

@@ -65,7 +65,7 @@ module Cryptum
         product_id = option_choice.symbol.to_s.gsub('_', '-').upcase
 
         api_secret = env[:api_secret]
-        api_signature_response = Cryptum::API.generate_signature(
+        api_signature_response = Cryptum::API::Signature.generate(
           api_secret: api_secret
         )
         api_key = env[:api_key]

data/spec/lib/cryptum/api/exchange_rates_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::API::ExchangeRates do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::API::ExchangeRates
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/api/fees_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::API::Fees do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::API::Fees
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/api/order_history_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::API::OrderHistory do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::API::OrderHistory
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/api/orders_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::API::Orders do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::API::Orders
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/api/portfolio_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::API::Portfolio do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::API::Portfolio
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/api/products_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::API::Products do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::API::Products
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/api/rest_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::API::Rest do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::API::Rest
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/api/signature_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::API::Signature do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::API::Signature
+    expect(help_response).to respond_to :help
+  end
+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