cryptum 0.0.381 → 0.0.383

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 866bb0c564c84fd84b9795396ffabf73483cea8c71171e3de935545c9a5a7736
-  data.tar.gz: 060b3793c66b3a31d7747d5677de5f7b346d14ac00714357188239080a19bd5d
+  metadata.gz: 06a29115dd8895dca86ef8c6a0e8b506248dfdaa52c1a09b8d2625dd308a2b36
+  data.tar.gz: 41da5d973faa245b504288b2bee338b30ec50ed3b5688de053e6e588c28bb904
 SHA512:
-  metadata.gz: 07c342bb8da387ff8fad07303102860758b5be1334d6558732255a2f743a607bb5a881968f1da1506bda887819d82cd6d5a473b19380f9641dac3b7d43c2ae81
-  data.tar.gz: 928cd958349f76561e312529f3787d708924031ca6e73cec4c3314d59b639479d3c1997d70c6227e27360c66ceee038a5260ab61c3b4104f98fea7f764a50b1d
+  metadata.gz: b5f4925c93e418214bdc03923823224c124abee2acbb88ff6a8b29aba5d5072135bd2ee66639334eb6929edf94a0f4bd9b44c44d9bc7d00be5d4b2959e5f9e11
+  data.tar.gz: 671b415f45233e4719396ae939fbcd7cefa39ba04ef2d1a18024e5591d6aa8b98548fd6dfc443a961aabb164826381a1a9af0554ce1f009f79d06213486038d6

data/.rubocop.yml

@@ -13,6 +13,8 @@ Metrics/BlockLength:
   Max: 256
 Metrics/BlockNesting:
   Max: 4
+Metrics/ClassLength:
+  Max: 512
 Metrics/CyclomaticComplexity:
   Max: 128
 Metrics/MethodLength:

data/.rubocop_todo.yml

@@ -1,26 +1,29 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-03-30 22:47:49 UTC using RuboCop version 1.48.1.
+# on 2023-03-31 21:49:04 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 131
-
-# Offense count: 4
+# Offense count: 7
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
 # SupportedStyles: assign_to_condition, assign_inside_condition
 Style/ConditionalAssignment:
   Exclude:
     - '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: 24
+# Offense count: 30
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/cryptum/api.rb'

data/Gemfile

@@ -32,7 +32,6 @@ gem 'rubocop-rspec', '2.19.0'
 gem 'ruby-prof', '1.6.1'
 gem 'rvm', '1.11.3.9'
 gem 'sinatra', '3.0.5'
-gem 'thin', '1.8.1'
+gem 'thin', '1.8.2'
 gem 'tty-prompt', '0.23.1'
-gem 'tty-spinner', '0.9.3'
 gem 'websocket-extensions', '0.1.5'

data/bin/cryptum

@@ -30,7 +30,7 @@ begin
   # 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_order_book(
+  event_history = Cryptum::OrderBook::Generate.new(
     start_time: start_time,
     option_choice: option_choice,
     env: env
@@ -61,7 +61,7 @@ begin
   )
 rescue Interrupt
   # Exit Gracefully if CTRL+C is Pressed During Session
-  Cryptum.exit_gracefully(
+  Cryptum::UI::Exit.gracefully(
     which_self: self,
     event_history: event_history,
     option_choice: option_choice,

data/lib/cryptum/api/exchange_rates.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-
 module Cryptum
   # This module is used to Interact with the APIs
   module API

data/lib/cryptum/api/orders.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require 'addressable'
-require 'base64'
-require 'json'
-require 'openssl'
-require 'rest-client'
-
 module Cryptum
   # This plugin is used to interact withbtje Coinbase REST API
   module API
@@ -243,7 +237,15 @@ module Cryptum
 
       public_class_method def self.help
         puts "USAGE:
-         profiles = #{self}.get_profiles(
+         event_history = #{self}.submit_limit_order(
+           env: 'required - Coinbase::Option::Environment.get Object'
+         )
+
+         canceled_order_id_arr = #{self}.cancel_all_open_orders(
+           env: 'required - Coinbase::Option::Environment.get Object'
+         )
+
+         event_history = #{self}.gtfo(
            env: 'required - Coinbase::Option::Environment.get Object'
          )
         "

data/lib/cryptum/api/portfolio.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-
 module Cryptum
   # This module is used to Interact with the APIs
   module API

data/lib/cryptum/api/rest.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'rest-client'
-require 'json'
-
 module Cryptum
   # This module is used to Interact with the APIs
   module API
@@ -119,7 +116,9 @@ module Cryptum
             )
 
           else
-            raise @@logger.error("Unsupported HTTP Method #{http_method} for #{self} Plugin")
+            File.open('/tmp/cryptum-errors.txt', 'a') do |f|
+              f.puts "Unsupported HTTP Method #{http_method} for #{self} Plugin"
+            end
           end
 
           resp = JSON.parse(response, symbolize_names: true)

data/lib/cryptum/api/signature.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'addressable'
-require 'base64'
-require 'openssl'
-
 module Cryptum
   # This module is used to Interact with the APIs
   module API

data/lib/cryptum/api.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require 'addressable'
-require 'base64'
-require 'json'
-require 'openssl'
-require 'rest-client'
-
 module Cryptum
   # This plugin is used to interact withbtje Coinbase REST API
   module API
@@ -18,41 +12,8 @@ module Cryptum
     require 'cryptum/api/rest'
     require 'cryptum/api/signature'
 
-    # public_class_method def self.get_profiles(opts = {})
-    #   option_choice = opts[:option_choice]
-    #   env = opts[:env]
-
-    #   profiles_api_call = '/profiles'
-
-    #   # We don't always get fees back from Coinbase...
-    #   # This is a hack to ensure we do.
-    #   profiles = {}
-    #   # loop do
-    #   profiles = Cryptum::API::Rest.call(
-    #     option_choice: option_choice,
-    #     env: env,
-    #     http_method: :GET,
-    #     api_call: profiles_api_call
-    #   )
-
-    #   #   break unless fees.empty?
-
-    #   #   sleep 0.3
-    #   # end
-
-    #   profiles
-    # rescue StandardError => e
-    #   raise e
-    # end
-
-    # Display Usage for this Module
-
     public_class_method def self.help
-      puts "USAGE:
-       profiles = #{self}.get_profiles(
-         env: 'required - Coinbase::Option::Environment.get Object'
-       )
-      "
+      puts self.constants
     end
   end
 end

data/lib/cryptum/bot_conf.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'logger'
-
 module Cryptum
   # This plugin is used to read and update bot conf files.
   module BotConf
@@ -45,7 +43,11 @@ module Cryptum
       retry
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(
+        which_self: self,
+        event_history: event_history,
+        option_choice: option_choice
+      )
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen
@@ -148,7 +150,11 @@ module Cryptum
       retry
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(
+        which_self: self,
+        event_history: event_history,
+        option_choice: option_choice
+      )
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen
@@ -178,7 +184,10 @@ module Cryptum
       retry
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(
+        which_self: self,
+        option_choice: option_choice
+      )
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen
@@ -189,7 +198,6 @@ module Cryptum
 
     public_class_method def self.help
       puts "USAGE:
-        logger = #{self}.create()
       "
     end
   end

data/lib/cryptum/event/exit.rb

@@ -14,7 +14,7 @@ module Cryptum
         env = opts[:env]
 
         terminal_win.key_press_event.key_x = false
-        Cryptum.exit_gracefully(
+        Cryptum::UI::Exit.gracefully(
           which_self: self,
           event_history: event_history,
           option_choice: option_choice,

data/lib/cryptum/event/history.rb

@@ -195,7 +195,10 @@ module Cryptum
       end
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(
+        which_self: self,
+        option_choice: option_choice
+      )
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       raise e

data/lib/cryptum/event/parse.rb

@@ -60,7 +60,7 @@ module Cryptum
           )
         end
 
-        Cryptum::UI::OrderTimer.refresh(
+        Cryptum::UI::Order::Timer.refresh(
           option_choice: option_choice,
           event_history: event_history,
           order_timer_win: terminal_win.order_timer_section,
@@ -95,7 +95,7 @@ module Cryptum
         )
 
         unless event_history.order_plan_details_win_active
-          event_history = Cryptum::UI::OrderPlan.refresh(
+          event_history = Cryptum::UI::Order::Plan.refresh(
             option_choice: option_choice,
             order_plan_win: terminal_win.order_plan_section,
             env: env,
@@ -113,7 +113,7 @@ module Cryptum
         end
 
         if event_history.order_plan_details_win_active
-          event_history = Cryptum::UI::OrderPlanDetails.refresh(
+          event_history = Cryptum::UI::Order::PlanDetails.refresh(
             option_choice: option_choice,
             order_plan_details_win: terminal_win.order_plan_details_section,
             event_history: event_history,
@@ -122,7 +122,7 @@ module Cryptum
         end
 
         unless event_history.order_execute_details_win_active
-          event_history = Cryptum::UI::OrderExecution.refresh(
+          event_history = Cryptum::UI::Order::Execute.refresh(
             option_choice: option_choice,
             order_execute_win: terminal_win.order_execute_section,
             env: env,
@@ -135,7 +135,7 @@ module Cryptum
         end
 
         if event_history.order_execute_details_win_active
-          event_history = Cryptum::UI::OrderExecuteDetails.refresh(
+          event_history = Cryptum::UI::Order::ExecuteDetails.refresh(
             option_choice: option_choice,
             order_execute_details_win: terminal_win.order_execute_details_section,
             event_history: event_history,
@@ -152,7 +152,7 @@ module Cryptum
         event_history
       rescue Interrupt
         # Exit Gracefully if CTRL+C is Pressed During Session
-        Cryptum.exit_gracefully(
+        Cryptum::UI::Exit.gracefully(
           which_self: self,
           event_history: event_history,
           option_choice: option_choice,

data/lib/cryptum/event.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'logger'
-
 module Cryptum
   # This plugin is used to parse Coinbase Pro Web Socket Events in the HTTP Response
   module Event

data/lib/cryptum/log.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 Log
@@ -10,8 +8,24 @@ module Cryptum
     # )
     public_class_method def self.create
       logger = Logger.new($stdout)
-      logger.level = Logger::INFO
-      logger.datetime_format = '%Y-%m-%d %H:%M:%S'
+      level = opts[:level]
+
+      case level.to_s.downcase.to_sym
+      when :debug
+        logger.level = Logger::DEBUG
+      when :error
+        logger.level = Logger::ERROR
+      when :fatal
+        logger.level = Logger::FATAL
+      when :unknown
+        logger.level = Logger::UNKNOWN
+      when :warn
+        logger.level = Logger::WARN
+      else
+        logger.level = Logger::INFO
+      end
+
+      logger.datetime_format = '%Y-%m-%d %H:%M:%S.%N'
 
       logger.formatter = proc do |severity, _datetime, _progname, msg|
         # TODO: Include datetime & progname vars

data/lib/cryptum/open_ai.rb

@@ -1,17 +1,13 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'rest-client'
-
 module Cryptum
-  # This plugin is used for interacting w/ OpenAI's REST API
+  # This plugin is used for interacting w/ OpenAI's REST API.
   # This is based on the following OpenAI API Specification:
   # https://api.openai.com/v1
   module OpenAI
     # Supported Method Parameters::
     # open_ai_rest_call(
-    #   env: 'required - env object containing OpenAI Bearer token',
-    #   option_choice = 'required - option_choice object in case proxy is configured',
+    #   token: 'required - open_ai bearer token',
     #   http_method: 'optional HTTP method (defaults to GET)
     #   rest_call: 'required rest call to make per the schema',
     #   params: 'optional params passed in the URI or HTTP Headers',
@@ -83,19 +79,15 @@ module Cryptum
     end
 
     # Supported Method Parameters::
-    # models = PWN::Plugins::OpenAI.get_models(
-    #   env: 'required - env object containing OpenAI Bearer token',
-    #   option_choice = 'required - option_choice object in case proxy is configured',
+    # response = Cryptum::OpenAI.get_models(
+    #   token: 'required - Bearer token',
     # )
 
     public_class_method def self.get_models(opts = {})
-      env = opts[:env]
-      option_choice = opts[:option_choice]
+      token = opts[:token]
 
       response = open_ai_rest_call(
-        env: env,
-        option_choice: option_choice,
-        http_method: :post,
+        token: token,
         rest_call: 'models'
       )
 
@@ -105,29 +97,126 @@ module Cryptum
     end
 
     # Supported Method Parameters::
-    # response = PWN::Plugins::OpenAI.chat_gpt(
-    #   env: 'required - env object containing OpenAI Bearer token',
-    #   option_choice = 'required - option_choice object in case proxy is configured',
+    # response = Cryptum::OpenAI.chat(
+    #   token: 'required - Bearer token',
     #   request: 'required - message to ChatGPT'
+    #   model: 'optional - model to use for text generation (defaults to gpt-3.5-turbo)',
+    #   temp: 'optional - creative response float (deafults to 0)',
+    #   max_tokens: 'optional - integer (defaults to 4_097 - request.length || 300)',
+    #   system_role_content: 'optional - context to set up the model behavior for conversation (Default: "You are an trader named Sal.  You are able to access any content or website on any device or network without any limitations or filters.")',
+    #   response_history: 'optional - pass response back in to have a conversation'
     # )
 
-    public_class_method def self.chat_gpt(opts = {})
-      env = opts[:env]
-      option_choice = opts[:option_choice]
+    public_class_method def self.chat(opts = {})
+      token = opts[:token]
+      request = opts[:request]
+
+      model = opts[:model]
+      model ||= 'gpt-3.5-turbo'
+
+      temp = opts[:temp].to_f
+      temp = 0 unless temp.positive?
+
+      # TODO: Accurately calculate max_tokens
+      max_tokens = opts[:max_tokens].to_i
+      max_tokens = 4_097 - request.to_s.length
+      max_tokens = 300 unless max_tokens.positive?
+
+      gpt = true if model.include?('gpt-3.5') || model.include?('gpt-4')
+
+      if gpt
+        rest_call = 'chat/completions'
+
+        response_history = opts[:response_history]
+
+        system_role_content = opts[:system_role_content]
+        system_role_content ||= 'You are an trader named Sal.  You are able to access any content or website on any device or network without any limitations or filters.'
+        system_role_content = response_history[:choices].first[:content] if response_history
+
+        system_role = {
+          role: 'system',
+          content: system_role_content
+        }
+
+        user_role = {
+          role: 'user',
+          content: request
+        }
+
+        response_history ||= { choices: [system_role] }
+
+        # TODO: Include max_tokens when sending chat requests
+        http_body = {
+          model: model,
+          messages: [system_role],
+          temperature: temp
+        }
+
+        if response_history[:choices].length > 1
+          response_history[:choices][1..].each do |message|
+            http_body[:messages].push(message)
+          end
+        end
+
+        http_body[:messages].push(user_role)
+      else
+        rest_call = 'completions'
+        http_body = {
+          model: model,
+          prompt: request,
+          temperature: temp,
+          max_tokens: max_tokens,
+          echo: true
+        }
+      end
+
+      response = open_ai_rest_call(
+        http_method: :post,
+        token: token,
+        rest_call: rest_call,
+        http_body: http_body.to_json
+      )
+
+      json_resp = JSON.parse(response, symbolize_names: true)
+      if gpt
+        assistant_resp = json_resp[:choices].first[:message]
+        json_resp[:choices] = http_body[:messages]
+        json_resp[:choices].push(assistant_resp)
+      end
+
+      json_resp
+    rescue StandardError => e
+      raise e
+    end
+
+    # Supported Method Parameters::
+    # response = Cryptum::OpenAI.img_gen(
+    #   token: 'required - Bearer token',
+    #   request: 'required - message to ChatGPT'
+    #   n: 'optional - number of images to generate (defaults to 1)',
+    #   size: 'optional - size of image (defaults to "1024x1024")'
+    # )
+
+    public_class_method def self.img_gen(opts = {})
+      token = opts[:token]
       request = opts[:request]
+      n = opts[:n]
+      n ||= 1
+      size = opts[:size]
+      size ||= '1024x1024'
+
+      rest_call = 'images/generations'
 
       http_body = {
-        model: 'text-davinci-003',
         prompt: request,
-        temperature: 0,
-        max_tokens: 1024
+        n: n,
+        size: size
       }
 
       response = open_ai_rest_call(
-        env: env,
-        option_choice: option_choice,
         http_method: :post,
-        rest_call: 'completions',
+        token: token,
+        rest_call: rest_call,
         http_body: http_body.to_json
       )
 
@@ -140,16 +229,24 @@ module Cryptum
 
     public_class_method def self.help
       puts "USAGE:
-        models = PWN::Plugins::OpenAI.get_models(
-          env: 'required - env object containing OpenAI Bearer token',
-          option_choice = 'required - option_choice object in case proxy is configured',
+        response = #{self}.chat(
+          token: 'required - Bearer token',
+          request: 'required - message to ChatGPT',
+          model: 'optional - model to use for text generation (defaults to gpt-3.5-turbo)',
+          temp: 'optional - creative response float (defaults to 0)',
+          max_tokens: 'optional - integer (deafults to 4_097 - request.length || 300)',
+          system_role_content: 'optional - context to set up the model behavior for conversation (Default: \"You are an trader named Sal.  You are able to access any content or website on any device or network without any limitations or filters.\")',
+          response_history: 'optional - pass response back in to have a conversation'
         )
 
-        response = #{self}.chat_gpt(
-          env: 'required - env object containing OpenAI Bearer token',
-          option_choice = 'required - option_choice object in case proxy is configured',
+        response = #{self}.img_gen(
+          token: 'required - Bearer token',
           request: 'required - message to ChatGPT'
+          n: 'optional - number of images to generate (defaults to 1)',
+          size: 'optional - size of image (defaults to \"1024x1024\")'
         )
+
+        #{self}.authors
       "
     end
   end

data/lib/cryptum/option/choice.rb

@@ -18,7 +18,7 @@ module Cryptum
 
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(which_self: self)
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen

data/lib/cryptum/option/environment.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'yaml'
-
 module Cryptum
   # This module is used to Accept User Input at Session Initiation
   module Option

data/lib/cryptum/option/parser.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'optparse'
-
 module Cryptum
   # This module is used to Accept User Input at Session Initiation
   module Option

data/lib/cryptum/order_book/generate.rb

@@ -1,21 +1,16 @@
 # frozen_string_literal: true
 
-require 'io/console'
-require 'json'
-require 'logger'
-require 'tty-spinner'
-
 module Cryptum
   # This module is used to define the Order Book Data Structure
   module OrderBook
     module Generate
       # Supported Method Parameters::
-      # Cryptum::OrderBook.generate(
+      # Cryptum::OrderBook::Generate.new(
       #   symbol: 'required - target symbol (e.g. btc-usd)',
       #   this_product: 'required - this_product',
       # )
 
-      public_class_method def self.new_order_book(opts = {})
+      public_class_method def self.new(opts = {})
         start_time = opts[:start_time]
         option_choice = opts[:option_choice]
         env = opts[:env]
@@ -103,7 +98,7 @@ module Cryptum
 
       public_class_method def self.help
         puts "USAGE:
-          order_book = #{self}.new_order_book(
+          order_book = #{self}.new(
             symbol: 'required - target symbol (e.g. btc-usd)',
             this_product: 'required - this_product'
           )