rh-console 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4caf5635220e379b72b6100e9c63e59d0846b2cc81895869a288a62379beb2c
+  data.tar.gz: 58a8a8cbd5c98a1cc41ceef48fdf93946fa1397c6210b5001ff128de9cc6620d
+SHA512:
+  metadata.gz: 656bd2edfe7f38ed3dd3ad4db3686ef20616e6cea0dd150494aac358042cb490596216729ae7c65c58b7ec1c3bd46b34b16c20ee966c4ef7177c818c1da8544e
+  data.tar.gz: 9c4dde382ed6500caaf3dd0931b060aad2946a2664000d4ab00efcce83645aae1bc84f715b6eebb97750a741de0ec44170baba22df69c44b9c61fa7b2b6dbc84

data/README.md

@@ -0,0 +1,78 @@
+## Robinhood console
+
+A Ruby command line interface to the Robinhood API:
+
+<img height="440" alt="rh-console" src="https://user-images.githubusercontent.com/6415223/78421025-6afd7480-7609-11ea-852a-39280b3ef671.png">
+
+### Installation
+
+:warning: WARNING: This is no longer maintained and has not been thoroughly used in years. It is **not** recommended to use this to place trades or perform any sensitive actions, as this is **not** an official product of Robinhood and the APIs it's making use of may change at any time :warning:
+
+Rh-console is hosted on RubyGems and can be installed via:
+
+`gem install rh-console`
+
+And you'll have access to a `rh-console` executable in your terminal.
+
+Alternatively, clone the repository and run it:
+```
+git clone https://github.com/brentjo/rh-console
+cd rh-console
+bin/rh-console
+```
+
+Or run with Docker:
+
+```
+docker build -f Dockerfile -t rh-console .
+docker run -it --rm rh-console
+```
+
+### Features
+
+- Stream live equity and option quotes
+- Place orders for equities and options
+- View order history and cancel open orders
+- Print a summary of your portfolio
+- View information about your account
+- Backup weekly historical data for your watchlist
+- Manually make authenticated requests to the API using the `get` command
+- The JWT authentication token auto-refreshes in the background.
+- Supports accounts with multi-factor authentication enabled
+
+### Development
+
+There are no dependencies -- only the ruby standard library is used, so simply clone, start making edits, and run with `bin/rh-console`.
+
+The few gems listed in the Gemfile are needed to run and record new tests, and can be installed with `bundle install`. Tests use [vcr](https://github.com/vcr/vcr) to record interactions with the Robinhood API. The initial recording hits the live API and your test cases make assertions based off it, but subsequent runs match against requests in the VCR recording.
+
+After making changes, update the YARD documentation with `bundle exec rake yard`.
+
+### Testing
+
+Install the dependencies and run tests via rake:
+```
+bundle install
+bundle exec rake test
+```
+
+Alternatively, build and run a Dockerfile:
+
+```
+docker build -f Dockerfile.ci -t rh-console-ci .
+docker run --rm rh-console-ci
+```
+
+**Command line interactions**
+Tests that assert that certain command line input should lead to certain library calls are within `test/test_robinhood_console.rb`.
+
+**Robinhood client**
+The actual client that interacts with the API to place orders, get quotes, etc, is tested within `test/test_unauthenticated_robinhood_client.rb` and `test/test_authenticated_robinhood_client.rb`. Unfortunately, because these VCR recordings are real API interactions, the cassettes for most tests are not checked into source control.
+
+### Documentation
+Full YARD documentation can be found at: https://brentjo.github.io/rh-console/top-level-namespace.html
+- [RobinhoodClient](./lib/robinhood_client.rb) - Contains the bulk of the code that handles making requests to the Robinhood API.
+- [RobinhoodConsole](./lib/robinhood_console.rb) - Contains all the code to handle taking in user input, parsing it, and sending it to the RobinhoodClient.
+- [Table](./lib/helpers/table.rb) - A method that takes an array of headers, and an array or rows, and formats it into a pretty table in the style of [`tj/terminal-table`](https://github.com/tj/terminal-table).
+- [HttpHelpers](./lib/helpers/http_helpers.rb) - Contains wrappers around `Net:HTTP`'s GET and POST methods to help craft the requests to the API.
+- [String](./initializers/string.rb) - String is monkey-patched to add some color helper methods so you're able to do `"text".red` and the text will be output red in the terminal.

data/bin/rh-console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/robinhood_console'
+
+console = RobinhoodConsole.new
+console.initialize_client
+console.print_help_text
+console.menu_loop

data/initializers/string.rb

@@ -0,0 +1,10 @@
+class String
+  def black;          "\e[30m#{self}\e[0m" end
+  def red;            "\e[31m#{self}\e[0m" end
+  def green;          "\e[32m#{self}\e[0m" end
+  def brown;          "\e[33m#{self}\e[0m" end
+  def blue;           "\e[34m#{self}\e[0m" end
+  def magenta;        "\e[35m#{self}\e[0m" end
+  def cyan;           "\e[36m#{self}\e[0m" end
+  def gray;           "\e[37m#{self}\e[0m" end
+end

data/lib/helpers/format_helpers.rb

@@ -0,0 +1,18 @@
+module FormatHelpers
+
+  # Formats a float to 2 decimal places and the color specified
+  #
+  # @param price [Float] The float to format
+  # @param color [Symbol] The color
+  # @return [String] The colored string rounded to 2 decimal places
+  # @example
+  #    FormatHelpers.format_float(123.4567, color: :green)
+  def self.format_float(price, color: nil)
+    rounded = '%.2f' % price
+    if color
+      rounded.send(color)
+    else
+      rounded
+    end
+  end
+end

data/lib/helpers/http_helpers.rb

@@ -0,0 +1,43 @@
+require "net/http"
+require "json"
+
+module HttpHelpers
+
+  # Make a GET request
+  #
+  # @param url [String] URL to make the request to
+  # @param headers [Hash] Headers to add to the request
+  # @param params [Hash] Parameters to add to the request
+  # @return [Net::HTTP] The response of the request
+  def self.get(url, headers: {}, params: {})
+    uri = URI.parse(url)
+    uri.query = URI.encode_www_form(params) unless params.empty?
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    request = Net::HTTP::Get.new(uri.request_uri)
+    headers.each do |key, value|
+      request[key] = value
+    end
+    response = http.request(request)
+    response
+  end
+
+  # Make a POST request
+  #
+  # @param url [String] URL to make the request to
+  # @param headers [Hash] Headers to add to the request
+  # @param body [Hash] Parameters to add to the request
+  # @return [Net::HTTP] The response of the request
+  def self.post(url, headers, body)
+    uri = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    request = Net::HTTP::Post.new(uri.request_uri)
+    headers.each do |key, value|
+      request[key] = value
+    end
+    request.body = body.to_json
+    response = http.request(request)
+    response
+  end
+end

data/lib/helpers/table.rb

@@ -0,0 +1,83 @@
+module Table
+
+  def self.new(headers, rows)
+
+    # Add 1 space padding to all values
+    headers.map! do |header|
+      header.prepend(" ")
+      header += " "
+      header
+    end
+
+    rows.map! do |row|
+      row.map! do |value|
+        # We don't want change the values of any variables passed in
+        # We only prepend spaces for visual purposes, so let's modify a dup instead
+        dupped_value = "" unless value
+        dupped_value = value.dup if value
+        dupped_value.prepend(" ")
+        dupped_value += " "
+        dupped_value
+      end
+    end
+
+    column_length = {}
+    headers.each_with_index do |value, index|
+      column_length[index] = value.length unless column_length.key?(index)
+      column_length[index] = value.length if value.length > column_length[index]
+    end
+
+    rows.each do |row|
+      row.each_with_index do |value, index|
+        column_length[index] = value.length unless column_length.key?(index)
+        column_length[index] = value.length if value.length > column_length[index]
+      end
+    end
+
+    table = "+"
+    headers.each_with_index do |value, index|
+      table += ("-" * column_length[index])
+      table += "+"
+    end
+    table += "\n"
+
+    table += "|"
+    headers.each_with_index do |value, index|
+      table += value + (" " * (column_length[index] - value.length))
+      table += "|"
+    end
+    table += "\n"
+
+    table += "+"
+    headers.each_with_index do |value, index|
+      table += "-" * column_length[index]
+      table += "+"
+    end
+    table += "\n"
+
+    rows.each do |row|
+      table += "|"
+      row.each_with_index do |value, index|
+        # Remove color characters so they don't count towards string length
+        value_for_length = value.gsub(/\e\[(\d+)m/, "")
+        value_for_length = value_for_length.gsub(/\e\[(\d+);(\d+);(\d+)m/, "")
+        num_spaces = (column_length[index] - value_for_length.length)
+        table += value
+        table += " " * num_spaces
+        table += "|"
+      end
+      table += "\n"
+    end
+
+    table += "+"
+    headers.each_with_index do |value, index|
+      table += ("-" * column_length[index])
+      table += "+"
+    end
+    table += "\n"
+
+    table
+
+  end
+
+end