squall 1.1.0 → 1.2.0beta1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Site5 LLC 
+Copyright (c) 2011 Site5.com <http://www.site5.com/>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -161,4 +161,4 @@ Note on Patches/Pull Requests
 Copyright
 ---------
 
-Copyright (c) 2012 Site5 LLC. See LICENSE for details.
+Copyright (c) 2012 Site5.com. See LICENSE for details.

data/lib/squall/support/base.rb

@@ -1,3 +1,5 @@
+Faraday.register_middleware :response, :on_app_errors => Squall::OnAppErrors
+
 module Squall
   # All OnApp API classes subclass Base to get access to
   # HTTParty methods and other convenience methods
@@ -11,21 +13,6 @@ module Squall
     # HTTPart request result
     attr_reader :result
 
-    # HTTParty class methods
-    include HTTParty
-
-    def initialize
-      self.class.base_uri Squall::config[:base_uri]
-      self.class.basic_auth Squall::config[:username], Squall::config[:password]
-      self.class.format :json
-      self.class.headers 'Content-Type' => 'application/json'
-      if Squall::config[:debug]
-        self.class.debug_output
-      else
-        self.class.debug_output(nil)
-      end
-    end
-
     # Returns a Params.new
     def params
       @params = Squall::Params.new
@@ -44,17 +31,6 @@ module Squall
       options.empty? ? {} : {:query => { key_for_class => options.first}}
     end
 
-    # Returns an array of Request errors
-    def errors
-      return [] if @success
-      err = {}
-      @result.each do |k,v|
-        err[k] ||= []
-        err[k].push v.respond_to?(:first) ? v.first : v
-      end
-      err
-    end
-
     # Peforms an HTTP Request
     #
     # ==== Options
@@ -68,18 +44,17 @@ module Squall
     #   request :put, '/something.json', :something => 1 # PUT /something.json?something=1
     def request(request_method, path, options = {})
       check_config
-      @result  = self.class.send(request_method, path, options)
-      @success = (200..207).include?(@result.code)
-      case @result.code
-      when (200..207)
-        @result
-      when 404
-        raise NotFound, @result
-      when 422
-        raise RequestError, @result
-      else
-        raise ServerError, @result
+      conn = Faraday.new(:url => Squall.config[:base_uri]) do |c|
+        c.basic_auth Squall.config[:username], Squall.config[:password]
+        c.params = (options[:query] || {})
+        c.request :url_encoded
+        c.response :on_app_errors
+        c.response :json
+        c.adapter :net_http
       end
+      response = conn.send(request_method, path)
+      @success = (200..207).include?(response.env[:status])
+      @result = conn.send(request_method, path).body
     end
 
     # Raises an error if a request is made without first calling Squall.config

data/lib/squall/support/exception.rb

@@ -1,13 +1,13 @@
 module Squall
+  # Config missing
+  class NoConfig < StandardError;end
+  
   # HTTP 404 not found
-  class NotFound < StandardError;end
-
-  # HTTP 500 error
-  class RequestError < StandardError;end
+  class NotFoundError < StandardError;end
 
   # HTTP 422
+  class ClientError < StandardError;end
+  
+  # HTTP 500 error
   class ServerError < StandardError;end
-
-  # Config missing
-  class NoConfig < StandardError;end
-end
+end

data/lib/squall/support/on_app_errors.rb

@@ -0,0 +1,23 @@
+module Squall
+  class OnAppErrors < Faraday::Response::Middleware
+
+    def on_complete(env)
+      # https://help.onapp.com/manual.php?m=2#p29
+      case env[:status]
+      when 403
+        raise Squall::ForbiddenError, response_values(env)
+      when 404
+        raise Squall::NotFoundError, response_values(env)
+      when 422
+        raise Squall::ClientError, response_values(env)
+      when 500
+        raise Squall::ServerError, response_values(env)
+      end
+    end
+
+    def response_values(env)
+      {:status => env[:status], :headers => env[:response_headers], :body => env[:body]}
+    end
+
+  end
+end

data/lib/squall/support/version.rb

@@ -1,3 +1,3 @@
 module Squall
-  VERSION = '1.1.0'
+  VERSION = '1.2.0beta1'
 end

data/lib/squall.rb

@@ -1,7 +1,9 @@
-require 'httparty'
+require 'faraday'
+require 'faraday_middleware'
 
 require 'squall/support/version'
 require 'squall/support/exception'
+require 'squall/support/on_app_errors'
 require 'squall/support/yaml'
 
 module Squall

data/spec/squall/data_store_zone_spec.rb

@@ -27,7 +27,7 @@ describe Squall::DataStoreZone do
     end
 
     it "returns not found for invalid data store zone id" do
-      expect { @data_store_zone.show(404) }.to raise_error(Squall::NotFound)
+      expect { @data_store_zone.show(404) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns a data store zone" do
@@ -74,7 +74,7 @@ describe Squall::DataStoreZone do
     end
     
     it "raises an error for an invalid data store zone id" do
-      expect { @data_store_zone.edit(404, @valid) }.to raise_error(Squall::NotFound)
+      expect { @data_store_zone.edit(404, @valid) }.to raise_error(Squall::NotFoundError)
     end
   end
   
@@ -90,7 +90,7 @@ describe Squall::DataStoreZone do
     end
 
     it "returns NotFound for invalid data store zone id" do
-      expect { @data_store_zone.delete(404) }.to raise_error(Squall::NotFound)
+      expect { @data_store_zone.delete(404) }.to raise_error(Squall::NotFoundError)
     end
   end
 

data/spec/squall/firewall_rule_spec.rb

@@ -54,7 +54,7 @@ describe Squall::FirewallRule do
     end
     
     it "raises an error for an invalid vm id" do
-      expect { @firewall_rule.create(404, @valid) }.to raise_error(Squall::NotFound)
+      expect { @firewall_rule.create(404, @valid) }.to raise_error(Squall::NotFoundError)
     end
 
     it "creates a firewall rule for a virtual machine" do
@@ -86,7 +86,7 @@ describe Squall::FirewallRule do
     end
     
     it "raises an error for an invalid firewall rule id" do
-      expect { @firewall_rule.edit(1, 404, @valid) }.to raise_error(Squall::NotFound)
+      expect { @firewall_rule.edit(1, 404, @valid) }.to raise_error(Squall::NotFoundError)
     end
   end
   
@@ -105,7 +105,7 @@ describe Squall::FirewallRule do
     end
 
     it "returns NotFound for missing virtual machine" do
-      expect { @firewall_rule.delete(1, 404) }.to raise_error(Squall::NotFound)
+      expect { @firewall_rule.delete(1, 404) }.to raise_error(Squall::NotFoundError)
     end
   end
 

data/spec/squall/hypervisor_spec.rb

@@ -28,7 +28,7 @@ describe Squall::Hypervisor do
     end
 
     it "returns not found for invalid hvs" do
-      expect { @hv.show(404) }.to raise_error(Squall::NotFound)
+      expect { @hv.show(404) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns a hv" do
@@ -89,7 +89,7 @@ describe Squall::Hypervisor do
     end
 
     it "404s on not found" do
-      expect { @hv.reboot(404) }.to raise_error(Squall::NotFound)
+      expect { @hv.reboot(404) }.to raise_error(Squall::NotFoundError)
       @hv.success.should be_false
     end
 
@@ -106,7 +106,7 @@ describe Squall::Hypervisor do
     end
 
     it "404s on not found" do
-      expect { @hv.delete(404) }.to raise_error(Squall::NotFound)
+      expect { @hv.delete(404) }.to raise_error(Squall::NotFoundError)
       @hv.success.should be_false
     end
 

data/spec/squall/hypervisor_zone_spec.rb

@@ -27,7 +27,7 @@ describe Squall::HypervisorZone do
     end
 
     it "returns not found for invalid hypervisor zone id" do
-      expect { @hypervisor_zone.show(404) }.to raise_error(Squall::NotFound)
+      expect { @hypervisor_zone.show(404) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns a hypervisor zone" do
@@ -74,7 +74,7 @@ describe Squall::HypervisorZone do
     end
     
     it "raises an error for an invalid hypervisor zone id" do
-      expect { @hypervisor_zone.edit(404, @valid) }.to raise_error(Squall::NotFound)
+      expect { @hypervisor_zone.edit(404, @valid) }.to raise_error(Squall::NotFoundError)
     end
   end
   
@@ -90,7 +90,7 @@ describe Squall::HypervisorZone do
     end
 
     it "returns NotFound for invalid hypervisor zone id" do
-      expect { @hypervisor_zone.delete(404) }.to raise_error(Squall::NotFound)
+      expect { @hypervisor_zone.delete(404) }.to raise_error(Squall::NotFoundError)
     end
   end
   

data/spec/squall/ip_address_join_spec.rb

@@ -13,7 +13,7 @@ describe Squall::IpAddressJoin do
     end
 
     it "raises NotFound with an invalid virtual machine ID" do
-      expect { @join.list(404) }.to raise_error(Squall::NotFound)
+      expect { @join.list(404) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns list of ip_addresses" do
@@ -38,7 +38,7 @@ describe Squall::IpAddressJoin do
     it "raises NotFound with an invalid virtual machine ID" do
       expect {
         @join.assign(404, {:ip_address_id => 1, :network_interface_id => 1})
-      }.to raise_error(Squall::NotFound)
+      }.to raise_error(Squall::NotFoundError)
     end
 
     it "assigns the IP join" do
@@ -56,7 +56,7 @@ describe Squall::IpAddressJoin do
     end
 
     it "raises NotFound with an invalid ID" do
-      expect { @join.delete(404, 1) }.to raise_error(Squall::NotFound)
+      expect { @join.delete(404, 1) }.to raise_error(Squall::NotFoundError)
     end
 
     it "deletes the IP join" do

data/spec/squall/ip_address_spec.rb

@@ -15,7 +15,7 @@ describe Squall::IpAddress do
     end
 
     it "404s on invalid network" do
-      expect { @ip.list(404) }.to raise_error(Squall::NotFound)
+      expect { @ip.list(404) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns ip_addresses" do

data/spec/squall/network_spec.rb

@@ -49,7 +49,7 @@ describe Squall::Network do
     end
 
     it "404s on not found" do
-      expect { @network.edit(404) }.to raise_error(Squall::NotFound)
+      expect { @network.edit(404) }.to raise_error(Squall::NotFoundError)
       @network.success.should be_false
     end
   end
@@ -64,7 +64,7 @@ describe Squall::Network do
       pending "Broken in OnApp" do
         expect { 
           @network.create(:label => 'networktaken')
-        }.to raise_error(Squall::RequestError)
+        }.to raise_error(Squall::ServerError)
         @network.errors['label'].should include("has already been taken")
       end
     end
@@ -108,7 +108,7 @@ describe Squall::Network do
     end
 
     it "404s on not found" do
-      expect { @network.delete(404) }.to raise_error(Squall::NotFound)
+      expect { @network.delete(404) }.to raise_error(Squall::NotFoundError)
       @network.success.should be_false
     end
 

data/spec/squall/network_zone_spec.rb

@@ -27,7 +27,7 @@ describe Squall::NetworkZone do
     end
 
     it "returns not found for invalid network zone id" do
-      expect { @network_zone.show(404) }.to raise_error(Squall::NotFound)
+      expect { @network_zone.show(404) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns a network zone" do
@@ -74,7 +74,7 @@ describe Squall::NetworkZone do
     end
     
     it "raises an error for an invalid network zone id" do
-      expect { @network_zone.edit(404, @valid) }.to raise_error(Squall::NotFound)
+      expect { @network_zone.edit(404, @valid) }.to raise_error(Squall::NotFoundError)
     end
   end
   
@@ -90,7 +90,7 @@ describe Squall::NetworkZone do
     end
 
     it "returns NotFound for invalid network zone id" do
-      expect { @network_zone.delete(404) }.to raise_error(Squall::NotFound)
+      expect { @network_zone.delete(404) }.to raise_error(Squall::NotFoundError)
     end
   end
 
@@ -106,11 +106,11 @@ describe Squall::NetworkZone do
     end
     
     it "returns NotFound error for invalid id" do
-      expect { @network_zone.attach(404, 1) }.to raise_error(Squall::NotFound)
+      expect { @network_zone.attach(404, 1) }.to raise_error(Squall::NotFoundError)
     end
     
     it "returns NotFound error for invalid network id" do
-      expect { @network_zone.attach(1, 404) }.to raise_error(Squall::NotFound)
+      expect { @network_zone.attach(1, 404) }.to raise_error(Squall::NotFoundError)
     end
     
     it "attaches a network to the network zone" do
@@ -131,11 +131,11 @@ describe Squall::NetworkZone do
     end
     
     it "returns NotFound error for invalid id" do
-      expect { @network_zone.detach(404, 1) }.to raise_error(Squall::NotFound)
+      expect { @network_zone.detach(404, 1) }.to raise_error(Squall::NotFoundError)
     end
     
     it "returns NotFound error for invalid network id" do
-      expect { @network_zone.detach(1, 404) }.to raise_error(Squall::NotFound)
+      expect { @network_zone.detach(1, 404) }.to raise_error(Squall::NotFoundError)
     end
     
     it "detaches a network to the network zone" do

data/spec/squall/payment_spec.rb

@@ -45,7 +45,7 @@ describe Squall::Payment do
     end
     
     it "raises an error for an invalid user id" do
-      expect { @payment.create(404, @valid) }.to raise_error(Squall::NotFound)
+      expect { @payment.create(404, @valid) }.to raise_error(Squall::NotFoundError)
     end
 
     it "creates a payment for a user" do
@@ -75,7 +75,7 @@ describe Squall::Payment do
     end
     
     it "raises an error for an invalid payment id" do
-      expect { @payment.edit(1, 404, @valid) }.to raise_error(Squall::NotFound)
+      expect { @payment.edit(1, 404, @valid) }.to raise_error(Squall::NotFoundError)
     end
   end
   
@@ -91,7 +91,7 @@ describe Squall::Payment do
     end
 
     it "returns NotFound for missing user" do
-      expect { @payment.delete(1, 404) }.to raise_error(Squall::NotFound)
+      expect { @payment.delete(1, 404) }.to raise_error(Squall::NotFoundError)
     end
   end
 

data/spec/squall/role_spec.rb

@@ -20,7 +20,7 @@ describe Squall::Role do
     end
 
     it "returns 404 for invalid id" do
-      expect { @role.show(404) }.to raise_error(Squall::NotFound)
+      expect { @role.show(404) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns a role" do
@@ -36,7 +36,7 @@ describe Squall::Role do
     end
 
     it "returns 404 for invalid id" do
-      expect { @role.edit(404) }.to raise_error(Squall::NotFound)
+      expect { @role.edit(404) }.to raise_error(Squall::NotFoundError)
     end
 
     it "allows all optional params" do
@@ -63,7 +63,7 @@ describe Squall::Role do
     end
 
     it "returns not found for invalid user" do
-      expect { @role.delete(5) }.to raise_error(Squall::NotFound)
+      expect { @role.delete(5) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns a role" do

data/spec/squall/support/base_spec.rb

@@ -12,24 +12,6 @@ describe Squall::Base do
     @base = Squall::Base.new
   end
 
-  describe "#initialize" do
-    it "sets the base_uri" do
-      @base.class.base_uri.should_not be_nil
-    end
-
-    it "sets credentials" do
-      @base.class.default_options[:basic_auth].should include(:username, :password)
-    end
-
-    it "uses JSON" do
-      @base.class.default_options[:format].should == :json
-    end
-
-    it "sets JSON headers" do
-      @base.class.default_options[:headers].should include('Content-Type' => 'application/json')
-    end
-  end
-
   describe "#request" do
     it "200-207 returns success" do
       (200..207).each do |i|
@@ -42,7 +24,7 @@ describe Squall::Base do
 
     it "raises NotFound for 404s" do
       mock_request(:get, '/404', :status => [404, "NotFound"])
-      expect { @base.request(:get, '/404') }.to raise_error(Squall::NotFound)
+      expect { @base.request(:get, '/404') }.to raise_error(Squall::NotFoundError)
       @base.success.should be_false
     end
 
@@ -54,7 +36,7 @@ describe Squall::Base do
 
     it "raises RequestError on errors" do
       mock_request(:get, '/422', :status => [422, "Unprocessable"])
-      expect { @base.request(:get, '/422') }.to raise_error(Squall::RequestError)
+      expect { @base.request(:get, '/422') }.to raise_error(Squall::ClientError)
       @base.success.should be_false
     end
 
@@ -64,20 +46,6 @@ describe Squall::Base do
     end
   end
 
-  describe "#errors" do
-    it "is empty on success" do
-      mock_request(:get, '/200_errors', :status => [200, "OK"], :body => "{\"something\":[\"errors\"]}")
-      @base.request(:get, '/200_errors')
-      @base.errors.should be_empty
-    end
-
-    it "returns an error hash" do
-      mock_request(:get, '/500_errors', :status => [500, "Internal Server Error"], :body => "{\"something\":[\"errors\"]}")
-      expect { @base.request(:get, '/500_errors') }.to raise_error(Squall::ServerError)
-      @base.errors.should_not be_empty
-    end
-  end
-
   describe "#params" do
     it "returns Params.new" do
       @base.params.should be_a(Squall::Params)

data/spec/squall/template_spec.rb

@@ -30,7 +30,7 @@ describe Squall::Template do
     end
 
     it "404s on not found" do
-      expect { @template.make_public(404) }.to raise_error(Squall::NotFound)
+      expect { @template.make_public(404) }.to raise_error(Squall::NotFoundError)
       @template.success.should be_false
     end
 

data/spec/squall/transaction_spec.rb

@@ -27,7 +27,7 @@ describe Squall::Transaction do
     end
 
     it "returns not found for invalid" do
-      expect { @transaction.show(5) }.to raise_error(Squall::NotFound)
+      expect { @transaction.show(5) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns a transaction" do

data/spec/squall/user_group_spec.rb

@@ -51,7 +51,7 @@ describe Squall::UserGroup do
     end
     
     it "raises an error for an invalid user group id" do
-      expect { @user_group.edit(404, @valid) }.to raise_error(Squall::NotFound)
+      expect { @user_group.edit(404, @valid) }.to raise_error(Squall::NotFoundError)
     end
   end
   
@@ -67,7 +67,7 @@ describe Squall::UserGroup do
     end
 
     it "returns NotFound for missing user" do
-      expect { @user_group.delete(404) }.to raise_error(Squall::NotFound)
+      expect { @user_group.delete(404) }.to raise_error(Squall::NotFoundError)
     end
   end
 

data/spec/squall/user_spec.rb

@@ -102,7 +102,7 @@ describe Squall::User do
     end
 
     it "returns not found for invalid users" do
-      expect { @user.show(404) }.to raise_error(Squall::NotFound)
+      expect { @user.show(404) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns a user" do
@@ -163,7 +163,7 @@ describe Squall::User do
     end
 
     it "returns NotFound for missing user" do
-      expect { @user.delete(404) }.to raise_error(Squall::NotFound)
+      expect { @user.delete(404) }.to raise_error(Squall::NotFoundError)
     end
   end
 
@@ -198,7 +198,7 @@ describe Squall::User do
     end
 
     it "404s on not found" do
-      expect { @user.virtual_machines(404) }.to raise_error(Squall::NotFound)
+      expect { @user.virtual_machines(404) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns the virtual_machines" do
@@ -214,7 +214,7 @@ describe Squall::User do
     end
 
     it "404s on not found" do
-      expect { @user.hypervisors(404) }.to raise_error(Squall::NotFound)
+      expect { @user.hypervisors(404) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns the virtual_machines" do
@@ -231,7 +231,7 @@ describe Squall::User do
 
     it "404s on not found" do
       pending "Broken on OnApp: returns success despite non-existent user" do
-        expect { @user.data_store_zones(2532564353245) }.to raise_error(Squall::NotFound)
+        expect { @user.data_store_zones(2532564353245) }.to raise_error(Squall::NotFoundError)
       end
     end
 
@@ -249,7 +249,7 @@ describe Squall::User do
 
     it "404s on not found" do
       pending "Broken on OnApp: returns success despite non-existent user" do
-        expect { @user.network_zones(2532564353245) }.to raise_error(Squall::NotFound)
+        expect { @user.network_zones(2532564353245) }.to raise_error(Squall::NotFoundError)
       end
     end
 
@@ -266,7 +266,7 @@ describe Squall::User do
     end
 
     it "404s on not found" do
-      expect { @user.limits(438768534623) }.to raise_error(Squall::NotFound)
+      expect { @user.limits(438768534623) }.to raise_error(Squall::NotFoundError)
     end
 
     it "returns the limits" do