vmfloaty 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bb5fd73f29e77b581fadb37b382fceb4131497b
-  data.tar.gz: c947c5941fd8d4f6b6aaaa4be3c320b5276b66f0
+  metadata.gz: 9bfa904ec8ca9ec10fa9c6c9571d5ebbb3a0647e
+  data.tar.gz: c6d347f9075dd4ecf5056ae39c4ff4f5f2b7e6e7
 SHA512:
-  metadata.gz: 1c4cc430096ff5b521deac4a1f8c4ad70ef2739d3419f4dbe54fff3bf9da87e0f6d94c4b9cb629565ba025ba8238fe079351f3d7b31a0a4985b6b7c4433412d9
-  data.tar.gz: 065e1253192e6f2c48caa3b152573c63cddfc36fe2190610403469e34ce43dd7252f09c86574df91fdec0cf7721da94d0c64c65d04b32d320cbf41a560d472ff
+  metadata.gz: 231d4ef21dc8ebb75b57511c4e4d33d8c77b2b0566027973c0a9e9cc790bc79a9bca532ab433b42600473e9811e867523a74927988524a11b4330542b639b85c
+  data.tar.gz: 88b32545eae35d0b49e366c5883052b20dcb38445c4ae534987b7de0bbb6246635ca5004c5cd8e095308692e0c817649655cf82aceab02b38a27bb380bb6d26f

data/lib/vmfloaty.rb

@@ -45,24 +45,45 @@ class Vmfloaty
 
         unless os_types.empty?
           if no_token
-            response = Pooler.retrieve(verbose, os_types, nil, url)
+            begin
+              response = Pooler.retrieve(verbose, os_types, nil, url)
+            rescue MissingParamError
+              STDERR.puts e
+              STDERR.puts "See `floaty get --help` for more information on how to get VMs."
+            rescue AuthError => e
+              STDERR.puts e
+              exit 1
+            end
             puts Utils.format_hosts(response)
             exit 0
           else
             unless token
               puts "No token found. Retrieving a token..."
               if !user
-                raise "You did not provide a user to authenticate to vmpooler with"
+                STDERR.puts "You did not provide a user to authenticate to vmpooler with"
+                exit 1
               end
               pass = password "Enter your password please:", '*'
-              token = Auth.get_token(verbose, url, user, pass)
-              unless token.nil?
-                puts "\nToken retrieved!"
-                puts token
+              begin
+                token = Auth.get_token(verbose, url, user, pass)
+              rescue TokenError => e
+                STDERR.puts e
+                exit 1
               end
+
+              puts "\nToken retrieved!"
+              puts token
             end
 
-            response = Pooler.retrieve(verbose, os_types, token, url)
+            begin
+              response = Pooler.retrieve(verbose, os_types, token, url)
+            rescue MissingParamError
+              STDERR.puts e
+              STDERR.puts "See `floaty get --help` for more information on how to get VMs."
+            rescue AuthError => e
+              STDERR.puts e
+              exit 1
+            end
             puts Utils.format_hosts(response)
             exit 0
           end
@@ -91,16 +112,18 @@ class Vmfloaty
 
         if active
           # list active vms
-          status = Auth.token_status(verbose, url, token)
-          unless status.nil?
-            # print vms
-            vms = status[token]['vms']
-            if vms.nil?
-              STDERR.puts "You have no running vms"
-              exit 0
-            end
-          else
-            STDERR.puts "Could not retrieve active vms"
+          begin
+            status = Auth.token_status(verbose, url, token)
+          rescue TokenError => e
+            STDERR.puts e
+            exit 1
+          end
+
+          # print vms
+          vms = status[token]['vms']
+          if vms.nil?
+            STDERR.puts "You have no running vms"
+            exit 0
           end
 
           running_vms = vms['running']
@@ -199,10 +222,10 @@ class Vmfloaty
 
         if delete_all
           # get vms with token
-          status = Auth.token_status(verbose, url, token)
-
-          if status.nil?
-            STDERR.puts "Could not retrieve status with token"
+          begin
+            status = Auth.token_status(verbose, url, token)
+          rescue TokenError => e
+            STDERR.puts e
             exit 1
           end
 
@@ -348,27 +371,33 @@ class Vmfloaty
         case action
         when "get"
           pass = password "Enter your password please:", '*'
-          token = Auth.get_token(verbose, url, user, pass)
-          unless token.nil?
-            puts token
-          else
-            STDERR.puts 'Could not make a request for a token'
+          begin
+            token = Auth.get_token(verbose, url, user, pass)
+          rescue TokenError => e
+            STDERR.puts e
+            exit 1
           end
+          puts token
+          exit 0
         when "delete"
           pass = password "Enter your password please:", '*'
-          result = Auth.delete_token(verbose, url, user, pass, token)
-          unless result.nil?
-            puts result
-          else
-            STDERR.puts 'Could not make a request to delete a token'
+          begin
+            result = Auth.delete_token(verbose, url, user, pass, token)
+          rescue TokenError => e
+            STDERR.puts e
+            exit 1
           end
+          puts result
+          exit 0
         when "status"
-          status = Auth.token_status(verbose, url, token)
-          unless status.nil?
-            puts status
-          else
-            STDERR.puts 'Could not make a request to get token status'
+          begin
+            status = Auth.token_status(verbose, url, token)
+          rescue TokenError => e
+            STDERR.puts e
+            exit 1
           end
+          puts status
+          exit 0
         when nil
           STDERR.puts "No action provided"
         else
@@ -404,15 +433,18 @@ class Vmfloaty
         if !no_token && !token
           puts "No token found. Retrieving a token..."
           if !user
-            raise "You did not provide a user to authenticate to vmpooler with"
+            STDERR.puts "You did not provide a user to authenticate to vmpooler with"
+            exit 1
           end
           pass = password "Enter your password please:", '*'
-          token = Auth.get_token(verbose, url, user, pass)
-          unless token.nil?
+          begin
+            token = Auth.get_token(verbose, url, user, pass)
+          rescue TokenError => e
+            STDERR.puts e
+            STDERR.puts 'Could not get token...requesting vm without a token anyway...'
+          else
             puts "\nToken retrieved!"
             puts token
-          else
-            STDERR.puts 'Could not get token...requesting vm without a token anyway...'
           end
         end
 

data/lib/vmfloaty/auth.rb

@@ -1,6 +1,7 @@
 require 'faraday'
 require 'json'
 require 'vmfloaty/http'
+require 'vmfloaty/errors'
 
 class Auth
   def self.get_token(verbose, url, user, password)
@@ -12,15 +13,13 @@ class Auth
     if res_body["ok"]
       return res_body["token"]
     else
-      STDERR.puts "There was a problem with your request:\n#{res_body}"
-      return nil
+      raise TokenError, "HTTP #{resp.status}: There was a problem requesting a token:\n#{res_body}"
     end
   end
 
   def self.delete_token(verbose, url, user, password, token)
     if token.nil?
-      STDERR.puts 'You did not provide a token'
-      return nil
+      raise TokenError, 'You did not provide a token'
     end
 
     conn = Http.get_conn_with_auth(verbose, url, user, password)
@@ -30,15 +29,13 @@ class Auth
     if res_body["ok"]
       return res_body
     else
-      STDERR.puts "There was a problem with your request:\n#{res_body}"
-      return nil
+      raise TokenError, "HTTP #{response.status}: There was a problem deleting a token:\n#{res_body}"
     end
   end
 
   def self.token_status(verbose, url, token)
     if token.nil?
-      STDERR.puts 'You did not provide a token'
-      return nil
+      raise TokenError, 'You did not provide a token'
     end
 
     conn = Http.get_conn(verbose, url)
@@ -49,8 +46,7 @@ class Auth
     if res_body["ok"]
       return res_body
     else
-      STDERR.puts "There was a problem with your request:\n#{res_body}"
-      return nil
+      raise TokenError, "HTTP #{response.status}: There was a problem getting the status of a token:\n#{res_body}"
     end
   end
 end

data/lib/vmfloaty/errors.rb

@@ -0,0 +1,17 @@
+class AuthError < StandardError
+  def initialize(msg="Could not authenticate to pooler")
+    super
+  end
+end
+
+class TokenError < StandardError
+  def initialize(msg="Could not do operation with token provided")
+    super
+  end
+end
+
+class MissingParamError < StandardError
+  def initialize(msg="Argument provided to function is missing")
+    super
+  end
+end

data/lib/vmfloaty/pooler.rb

@@ -1,6 +1,7 @@
 require 'faraday'
 require 'vmfloaty/http'
 require 'json'
+require 'vmfloaty/errors'
 
 class Pooler
   def self.list(verbose, url, os_filter=nil)
@@ -19,6 +20,9 @@ class Pooler
   end
 
   def self.retrieve(verbose, os_type, token, url)
+    # NOTE:
+    #   Developers can use `Utils.generate_os_hash` to
+    #   generate the os_type param.
     conn = Http.get_conn(verbose, url)
     if token
       conn.headers['X-AUTH-TOKEN'] = token
@@ -34,16 +38,19 @@ class Pooler
     os_string = os_string.chomp("+")
 
     if os_string.size == 0
-      raise "No operating systems provided to obtain. See `floaty get --help` for more information on how to get VMs."
+      raise MissingParamError, "No operating systems provided to obtain."
     end
 
     response = conn.post "vm/#{os_string}"
 
     res_body = JSON.parse(response.body)
+
     if res_body["ok"]
       res_body
+    elsif response.status == 401
+      raise AuthError, "HTTP #{response.status}: The token provided could not authenticate to the pooler.\n#{res_body}"
     else
-      raise "Failed to obtain VMs from the pooler at #{url}/vm/#{os_string}. #{res_body}"
+      raise "HTTP #{response.status}: Failed to obtain VMs from the pooler at #{url}/vm/#{os_string}. #{res_body}"
     end
   end
 

data/lib/vmfloaty/version.rb

@@ -1,6 +1,6 @@
 
 class Version
-  @version = '0.6.2'
+  @version = '0.7.0'
 
   def self.get
     @version

data/spec/vmfloaty/auth_spec.rb

@@ -20,6 +20,14 @@ describe Pooler do
       token = Auth.get_token(false, @vmpooler_url, "first.last", "password")
       expect(token).to eq @token
     end
+
+    it "raises a token error if something goes wrong" do
+      stub_request(:post, "https://first.last:password@vmpooler.example.com/token").
+                 with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Length'=>'0', 'User-Agent'=>'Faraday v0.9.2'}).
+                 to_return(:status => 500, :body => "{\"ok\":false}", :headers => {})
+
+      expect{ Auth.get_token(false, @vmpooler_url, "first.last", "password") }.to raise_error(TokenError)
+    end
   end
 
   describe "#delete_token" do
@@ -35,6 +43,18 @@ describe Pooler do
 
       expect(Auth.delete_token(false, @vmpooler_url, "first.last", "password", @token)).to eq JSON.parse(@delete_token_response)
     end
+
+    it "raises a token error if something goes wrong" do
+      stub_request(:delete, "https://first.last:password@vmpooler.example.com/token/utpg2i2xswor6h8ttjhu3d47z53yy47y").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.2'}).
+        to_return(:status => 500, :body => "{\"ok\":false}", :headers => {})
+
+      expect{ Auth.delete_token(false, @vmpooler_url, "first.last", "password", @token) }.to raise_error(TokenError)
+    end
+
+    it "raises a token error if no token provided" do
+      expect{ Auth.delete_token(false, @vmpooler_url, "first.last", "password", nil) }.to raise_error(TokenError)
+    end
   end
 
   describe "#token_status" do
@@ -50,5 +70,17 @@ describe Pooler do
 
       expect(Auth.token_status(false, @vmpooler_url, @token)).to eq JSON.parse(@token_status_response)
     end
+
+    it "raises a token error if something goes wrong" do
+      stub_request(:get, "#{@vmpooler_url}/token/utpg2i2xswor6h8ttjhu3d47z53yy47y").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Faraday v0.9.2'}).
+        to_return(:status => 500, :body => "{\"ok\":false}", :headers => {})
+
+      expect{ Auth.token_status(false, @vmpooler_url, @token) }.to raise_error(TokenError)
+    end
+
+    it "raises a token error if no token provided" do
+      expect{ Auth.token_status(false, @vmpooler_url, nil) }.to raise_error(TokenError)
+    end
   end
 end

data/spec/vmfloaty/pooler_spec.rb

@@ -44,6 +44,16 @@ describe Pooler do
       @retrieve_response_body_double = "{\"ok\":true,\"debian-7-i386\":{\"hostname\":[\"sc0o4xqtodlul5w\",\"4m4dkhqiufnjmxy\"]},\"centos-7-x86_64\":{\"hostname\":\"zb91y9qbrbf6d3q\"}}"
     end
 
+    it "raises an AuthError if the token is invalid" do
+      stub_request(:post, "#{@vmpooler_url}/vm/debian-7-i386").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Length'=>'0', 'User-Agent'=>'Faraday v0.9.2', 'X-Auth-Token'=>'mytokenfile'}).
+        to_return(:status => 401, :body => "{\"ok\":false}", :headers => {})
+
+      vm_hash = {}
+      vm_hash['debian-7-i386'] = 1
+      expect{ Pooler.retrieve(false, vm_hash, 'mytokenfile', @vmpooler_url) }.to raise_error(AuthError)
+    end
+
     it "retrieves a single vm with a token" do
       stub_request(:post, "#{@vmpooler_url}/vm/debian-7-i386").
         with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Length'=>'0', 'User-Agent'=>'Faraday v0.9.2', 'X-Auth-Token'=>'mytokenfile'}).

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: vmfloaty
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Brian Cain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2016-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 description: A helper tool for vmpooler to help you stay afloat
@@ -52,6 +52,7 @@ files:
 - lib/vmfloaty.rb
 - lib/vmfloaty/auth.rb
 - lib/vmfloaty/conf.rb
+- lib/vmfloaty/errors.rb
 - lib/vmfloaty/http.rb
 - lib/vmfloaty/pooler.rb
 - lib/vmfloaty/ssh.rb
@@ -71,17 +72,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: CLI application to interface with vmpooler