red_drop 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 650b690e863fa3223fa8111c28f1105f644107396b006614980e6394096d8f59
-  data.tar.gz: 23a050d37eb35151c4c91fb08a98d98a074d897e4aab159610bf157ec1bbe183
+  metadata.gz: 39b5e008df5f5d43afd211101c2ac866a9446c310a2ebbbb153924c5071984e2
+  data.tar.gz: b56a8836f6013f1c85e5d791389dd007986a7f62d4dfc98473e3402312537d2f
 SHA512:
-  metadata.gz: e24b7f0d8a9f898a75f79aef5e3e6a448ea8a58880c430a4b386361e84e10bab1493be6d56a1b60a6311eab83b7bf1420e55b94e5d883a6bfaa7608831894682
-  data.tar.gz: 14c7800731c053b00a2d2562dbb5b4e2ab4688551ec0c85068f3907abe100773642fee970fb3d6b69f371ab0c62757679c7606aaac0ebd45b201a208673dd631
+  metadata.gz: 07fb962ef9b66d417b6c6467727946c559da5e3bca564368ca5173255afe41f4ce540277ab4a0f8f2b18a45c28d00ce8e268024e37c93f310ee6c96cb5892420
+  data.tar.gz: 8575bbfb5f2e53383b1b00e0c7ea3514910bc6e59d9be538c878190f0c91ae5fd30a2c0064566e1e1212a937cee5ccd144d63b57a9282be49d3693b53354e3b7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    red_drop (0.3.1)
+    red_drop (0.4.0)
       droplet_kit (~> 3.18)
 
 GEM

data/README.md

@@ -1,6 +1,14 @@
-# red_drop
+# red_drop:drop_of_blood: [![Gem Version](https://badge.fury.io/rb/red_drop.svg)](https://badge.fury.io/rb/red_drop)
 
-Simple cli for automating droplet management with sane defaults baked in.
+Simple "interactive" cli for automating digitalocean droplet management with sane defaults baked in for research and development.
+
+Expirementing with the cloud can be expensive and stressful when you have to manually setup and take down Virtual Machines in order to avoid unwanted charges.
+
+Have you ever wonderd "Hmmm... If only there was a simple way to have a linux server in the cloud so that I can fully take advantage of all those free new member credits"?
+
+Most tools are not geared towards automating provisioning for simple research and development on cloud platforms. In fact they can be quite overwhelming with the multitude of different configurations they provide on all their cloud services.
+
+red_drop is an easy to use tool that will take the stress out of provisioning and destroying droplets with reasonable configurations for research and development on digitalocean's cloud.
 
 ## Installation
 
@@ -14,8 +22,18 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+After installing the gem, simply enter the following command:
+
     $ red_drop
 
+It will then try to look for a valid authentication token. If it can't find one it will prompt you for one. You can find yours or generate one from the API tab on your digitalocean dashboard panel.
+
+In order to use this tool you will need a digitalocean account with a payment method on your account. You can use the referral badge below to sign up with $200 of free credit for 60 days to use as your payment method.
+
+[![DigitalOcean Referral Badge](https://web-platforms.sfo2.digitaloceanspaces.com/WWW/Badge%203.svg)](https://www.digitalocean.com/?refcode=9a321408e86f&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge)
+
+The referral badge above will also help fund research and developmet on the project.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -29,13 +47,25 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/sergio
 ### Todos
 
 -   Research: TDD whether its w/ minitest or rspec
--   Refactor: status module to match delete module droplets data structure
--   Research: converting delete module droplets array to hash to avoid accidental deletions
--   Refactor: delete module while loop to match that of red_drop.rb
--   Research: Faraday, used by DropletKit, to replace built-in HTTP client library
--   Research: status module to get ip address of runnning droplets
--   Research: delete module to get droplet status before executing
--   Research: using cloud_init to automate server config for SSH, ufw, docker
+-   Research: authenticating ssh key on DigitalOcean to eventually disable password login
+-   Research: delete and status class to filter droplet destroy status before puts droplets
+-   Research: \# frozen_string_literal: true "magic comment"
+-   Research: File system programming in Ruby
+-   Research: replacing droplet_kit wrapper for vanilla Faraday http client library
+-   Features: cloud-init cloud-config.yaml for user_data in create class request
+-   Research: including created_at when puts droplets
+
+### Useful Links
+
+[Ruby language reference](https://www.ruby-lang.org/en/)
+
+[RubyGems docs](https://guides.rubygems.org/)
+
+[Faraday: http client library](https://lostisland.github.io/faraday/)
+
+[DigitalOcean API reference](https://docs.digitalocean.com/reference/api/)
+
+[cloud-init reference](https://cloudinit.readthedocs.io/en/latest/topics/modules.html)
 
 ## License
 

data/exe/red_drop

@@ -2,4 +2,4 @@
 
 require "red_drop"
 
-RedDrop.start
+RedDrop.new.begin

data/lib/red_drop/auth.rb

@@ -1,27 +1,28 @@
-require "net/http"
+require "faraday"
 
 class Auth
   def initialize
+    puts "loading..."
+
     file = File.open("secret.txt", "a+")
     @secret = file.read
     file.close
 
-    uri = URI('https://api.digitalocean.com/v2/droplets')
-    @http = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https')
-    @req = Net::HTTP::Get.new(uri)
-
-    @req["Authorization"] = "Bearer #{@secret}"
-    @res = @http.request(@req)
+    @faraday = Faraday.new("https://api.digitalocean.com/v2/droplets")
+    @res = @faraday.get do |req|
+      req.headers["Authorization"] = "Bearer #{@secret}"
+    end
   end
 
   def token
-    while @secret.empty? or not @res.code === "200"
-      puts "There in no valid API token in memory,\nplease enter a valid API token."
+    while @secret.empty? or not @res.success?
+      puts "\nThere in no valid API token in memory,\nplease enter a valid API token."
       @secret = gets.chomp
       File.write("secret.txt", @secret)
 
-      @req["Authorization"] = "Bearer #{@secret}"
-      @res = @http.request(@req)
+      @res = @faraday.get do |req|
+        req.headers["Authorization"] = "Bearer #{@secret}"
+      end
     end
     @secret
   end

data/lib/red_drop/create.rb

@@ -5,8 +5,9 @@ class Create
 
   def execute
     puts "loading... \n\n"
+    #user_data = File.read("cloud-config.yaml")
 
-    droplet = DropletKit::Droplet.new(name: 'drop', region: 'nyc1', size: 's-1vcpu-512mb-10gb', image: 'ubuntu-22-04-x64')
+    droplet = DropletKit::Droplet.new(name: 'RedDrop', region: 'nyc1', size: 's-1vcpu-512mb-10gb', image: 'ubuntu-22-04-x64')
     response = @client.droplets.create(droplet)
 
     puts "Your droplet: #{response.id}, is being provisioned.\n"

data/lib/red_drop/delete.rb

@@ -4,31 +4,33 @@ class Delete
   end
 
   def execute
-    puts "loading... \n\n"
+    puts "loading... \n"
 
     droplets = @client.droplets.all.map { |droplet| droplet.to_h }
 
     if droplets.length == 0
-      puts "There are no droplets in your DigitalOcean cloud.\n"
+      puts "\nThere are no droplets in your DigitalOcean cloud.\n"
       return
     end
 
-    puts "option: droplet_id\n"
-    droplets.each_with_index { |droplet, index| puts "#{index}: #{droplet[:id]}" }
-    puts "\nPlease enter an option for a droplet to delete?\n\n"
-    num = gets.to_i
+    hash = {}
+    droplets.each_with_index { |drop, i| hash[i.to_s] = drop } 
+    droplets = hash
 
-    while not droplets[num]
-      puts "\n#{num} is not a valid option, please enter a valid option\n\n"
-      num = gets.to_i
+    option = nil
+
+    until droplets.has_key? option
+      puts "\noption: droplet_id\n"
+      droplets.each { |key, droplet| puts "#{key}: #{droplet[:id]}" }
+      puts "\nPlease enter an option for a droplet to delete?\n\n"
+
+      option = gets.chomp
     end
 
-    response = @client.droplets.delete(id: droplets[num][:id])
+    response = @client.droplets.delete(id: droplets[option][:id])
 
     if response
       puts "\ndelete request processed succesfully\n\n"
-    else
-      result
     end
   end
 end

data/lib/red_drop/status.rb

@@ -6,16 +6,24 @@ class Status
   def execute
     puts "loading... \n\n"
 
-    droplets = @client.droplets.all.map { |droplet| { "droplet_id" => droplet.id, "status" => droplet.status } }
-    status = { "new" => "provisioning", "active" => "running" }
-    droplets.each { |drop| drop["status"] = status[drop["status"]] } 
+    droplets = @client.droplets.all.map { |droplet| droplet.to_h }
 
     if droplets.length == 0
       puts "There are no droplets in your DigitalOcean cloud."
       return
     end
 
-    droplets.each { |droplet| puts droplet}
+    droplets.each do |droplet|
+      droplet[:networks] = droplet[:networks][:v4].find { |n| n[:type] == "public" } 
+
+      if droplet[:networks]
+        droplet[:ip] = "running on #{droplet[:networks][:ip_address]}"
+      else
+        droplet[:ip] = "ip not yet assigned, try again in a minute"
+      end
+
+      puts "droplet: #{droplet[:id]} #{droplet[:ip]}"
+    end
   end
 end
 

data/lib/red_drop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RedDrop
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/red_drop.rb

@@ -1,27 +1,29 @@
 require "red_drop/auth"
-require 'droplet_kit'
+require "droplet_kit"
 require "red_drop/create"
 require "red_drop/status"
 require "red_drop/delete"
 
 class RedDrop
-  client = DropletKit::Client.new(access_token: Auth.new.token)
+  def initialize
+    client = DropletKit::Client.new(access_token: Auth.new.token)
 
-  @@task_menu = {
-    "create" => Create.new(client),
-    "status" => Status.new(client),
-    "delete" => Delete.new(client)
-  }
+    @task_menu = {
+      "create" => Create.new(client),
+      "status" => Status.new(client),
+      "delete" => Delete.new(client)
+    }
+  end
 
-  def self.start
+  def begin
     input = nil
 
     until input.eql? "exit"
-      puts "\nEnter from task menu below.\n#{@@task_menu.keys << "exit"}\n\n"
+      puts "\nEnter from task menu below.\n#{@task_menu.keys << "exit"}\n\n"
 
       input = gets.chomp 
 
-      @@task_menu[input].execute if @@task_menu.has_key? input
+      @task_menu[input].execute if @task_menu.has_key? input
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: red_drop
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Sergio Ortiz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-reporters