squall 0.0.3 → 1.0.0

data/.gitignore

@@ -0,0 +1,10 @@
+pkg/*
+*.gem
+.bundle
+.idea
+*.swp
+test.rb
+*~
+coverage/
+doc/
+TODO

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.8.7@squall

data/.travis.yml

@@ -0,0 +1,7 @@
+script: "rake spec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - rbx
+  - jruby

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    squall (1.0.0)
+      httparty (~> 0.7.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    Saikuro (1.1.0)
+    abstract (1.0.0)
+    activesupport (3.0.6)
+    arrayfields (4.7.4)
+    awesome_print (0.3.2)
+    chronic (0.3.0)
+    churn (0.0.13)
+      chronic (>= 0.2.3)
+      hirb
+      json_pure
+      main
+      ruby_parser (~> 2.0.4)
+      sexp_processor (~> 3.0.3)
+    colored (1.2)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    fakeweb (1.3.0)
+    fattr (2.2.0)
+    flay (1.4.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    flog (2.5.1)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    haml (3.0.25)
+    hirb (0.4.3)
+    httparty (0.7.7)
+      crack (= 0.1.8)
+    i18n (0.5.0)
+    json_pure (1.5.1)
+    main (4.4.0)
+      arrayfields (>= 4.7.4)
+      fattr (>= 2.1.0)
+    metric_fu (2.1.1)
+      Saikuro (>= 1.1.0)
+      activesupport (>= 2.0.0)
+      chronic (~> 0.3.0)
+      churn (>= 0.0.7)
+      flay (>= 1.2.1)
+      flog (>= 2.3.0)
+      rails_best_practices (>= 0.6.4)
+      rcov (>= 0.8.3.3)
+      reek (>= 1.2.6)
+      roodi (>= 2.1.0)
+      syntax
+    rails_best_practices (0.7.5)
+      activesupport
+      colored (~> 1.2)
+      erubis (~> 2.6.6)
+      haml (~> 3.0.18)
+      i18n
+      ruby-progressbar (~> 0.0.9)
+      ruby_parser (~> 2.0.4)
+    rcov (0.9.9)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    ruby-progressbar (0.0.9)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.5)
+    syntax (1.0.0)
+    vcr (1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  fakeweb (~> 1.3)
+  metric_fu (~> 2.1)
+  rcov (~> 0.9)
+  rspec (~> 2.5)
+  squall!
+  vcr (~> 1.8)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Justin Mazzi
+Copyright (c) 2011 Site5 LLC 
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,69 @@
+Squall
+=======
+[![Build Status](http://travis-ci.org/site5/squall.png)](http://travis-ci.org/site5/squall)
+
+
+A Ruby library for working with the OnApp REST API
+
+[RDoc](http://rdoc.info/github/site5/squall/master/frames)
+
+Confirmed to work with ruby 1.8.7, 1.9.2, Rubinis, REE and JRuby 1.6.0 with OnApp 2.1
+
+Install
+-------
+
+    gem install squall
+
+
+Usage
+-----
+
+Configure
+
+    require 'squall'
+
+    Squall.config do |c|
+      c.base_uri 'https://onappurl.com'
+      c.username 'username'
+      c.password 'topsecret'
+    end
+
+Show the info for a VM
+
+    vm = Squall::VirtualMachine.new
+    vm.show 1
+
+
+Create a new VM
+
+    vm = Squall::VirtualMachine.new
+
+    params = {
+      :label => 'testmachine', 
+      :hypervisor_id => 5,
+      :hostname => 'testmachine', 
+      :memory => 512, 
+      :cpus => 1,
+      :cpu_shares => 10, 
+      :primary_disk_size => 10
+    }
+
+    vm.create params
+
+
+
+Note on Patches/Pull Requests
+=======
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+=======
+
+Copyright (c) 2011 Site5 LLC. See LICENSE for details.

data/Rakefile

@@ -1,55 +1,61 @@
-require 'rubygems'
-require 'rake'
-
+require 'bundler'
+require 'uri'
 begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "squall"
-    gem.summary = %Q{A Ruby library for working with the OnApp REST API}
-    gem.description = %Q{A Ruby library for working with the OnApp REST API}
-    gem.email = "jmazzi@site5.com"
-    gem.homepage = "http://www.site5.com"
-    gem.authors = ["Justin Mazzi"]
-    gem.add_dependency 'rest-client'
-    gem.add_dependency 'json'
-    gem.add_development_dependency 'fakeweb'
-    gem.add_development_dependency 'redgreen'
-  end
-  Jeweler::GemcutterTasks.new
+  require 'rspec/core/rake_task'
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+  puts "Please install rspec (bundle install)"
+  exit
 end
 
 begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
+  require 'metric_fu'
+  MetricFu::Configuration.run do |config|
+    config.rcov[:rcov_opts] << "-Ispec"
   end
 rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
 end
 
-task :test => :check_dependencies
+RSpec::Core::RakeTask.new :spec
+Bundler::GemHelper.install_tasks
 
-task :default => :test
+desc "Sanitize sensitive info from cassettes"
+task :sanitize_cassettes do
+  yaml = File.join(ENV['HOME'], '.squall.yml')
+  if File.exists?(yaml)
+    config = YAML::load_file(yaml)
+    uri  = URI.parse(config['base_uri']).host
+    user = config['username']
+    pass = config['password']
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+    path = File.join(File.dirname(__FILE__), 'spec', 'vcr_cassettes')
+    files = Dir.glob("#{path}/**/*.yml")
+    if files.any?
+      files.each do |file|
+        old = File.read(file)
+        # if old.match(/#{uri}|#{user}|#{pass}/)
+          puts "Sanitizing #{file}"
+          old.gsub!(user, 'user')
+          old.gsub!(pass, 'pass')
+          old.gsub!(uri, 'www.example.com')
+          old.gsub!(/_onapp_session=(.*?);/, "_onapp_session=WHAT;")
+          old.gsub!(/- Basic .*/, "- Basic WHAT")
+          File.open(file, 'w') do |f| 
+            f.write old 
+          end 
+        # end 
+      end 
+    else
+      puts "Nothing to sanitize"
+    end 
+  else
+    puts "I can't sanitize without setting up WHM_HASH and WHM_HOST"
+  end 
+end
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "squall #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+desc  "Run all specs with rcov"
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/,features\/}
 end
+
+task :default => [:spec]

data/lib/squall/base.rb

@@ -0,0 +1,96 @@
+module Squall
+  # All OnApp API classes subclass Base to get access to 
+  # HTTParty methods and other convenience methods
+  class Base
+    # Params instance
+    attr_reader :params
+
+    # Returns true/false for successful/unsuccessful requests
+    attr_reader :success
+
+    # 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'
+      # self.class.debug_output
+    end
+
+    # Returns a Params.new
+    def params
+      @params = Squall::Params.new
+    end
+
+    # Sets the default URL params for requests and merges +options+
+    #
+    # ==== Options
+    #
+    # * +options+
+    #
+    # ==== Example
+    #
+    #   default_params(:something => 1)
+    def default_params(*options)
+      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
+    # * +request_method+ - The HTTP verb for the #request. (:get/:post/:delete etc)
+    # * +path+ - URL path
+    # * +options+ - HTTP query params
+    #
+    # ==== Example
+    #
+    #   request :get, '/something.json' # GET /seomthing.json
+    #   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
+      end
+    end
+
+    # Raises an error if a request is made without first calling Squall.config
+    def check_config
+      raise NoConfig, "Squall.config must be specified" if Squall.config.empty?
+    end
+
+    # Sets the default param container for request. It is derived from the 
+    # class name. Given the class name *Sandwich* and a param *bread* the 
+    # resulting params would be 'bob[bread]=wheat'
+    def key_for_class
+      word = self.class.name.split("::").last.to_s.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word.to_sym
+    end
+  end
+end

data/lib/squall/config.rb

@@ -0,0 +1,26 @@
+module Squall
+  # Holds the configuration for Squall
+  class Config
+    attr_accessor :config
+
+    def initialize
+      @config = {}
+    end
+
+    def [](v)
+      @config[v]
+    end
+
+    def base_uri(value)
+      @config[:base_uri]  = value
+    end
+
+    def username(value)
+      @config[:username] = value
+    end
+
+    def password(value)
+      @config[:password] = value
+    end
+  end
+end

data/lib/squall/exception.rb

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

data/lib/squall/hypervisor.rb

@@ -1,30 +1,60 @@
 module Squall
-  class Hypervisor < Client
-
-    URI_PREFIX = 'settings/hypervisors'
+  # OnApp Hypervisor
+  class Hypervisor < Base
 
+    # Returns a list of all Hypervisors
     def list
-      if get(URI_PREFIX)
-        @message.collect { |res| res['hypervisor'] }
-      else
-        []
-      end
+      req = request(:get, '/settings/hypervisors.json')
+      req.collect { |hv| hv['hypervisor'] }
     end
 
+    # Returns the Hypervisor info as a Hash
+    #
+    # ==== Options
+    #
+    # * +id+ - The id of the Hypervisor
     def show(id)
-      get("#{URI_PREFIX}/#{id}") ? @response['hypervisor'] : false
+      req = request(:get, "/settings/hypervisors/#{id}.json")
+      req.first[1]
+    end
+
+    # Create a new Hypervisor
+    #
+    # ==== Options
+    #
+    # * +options+ - Params for creating the Hypervisor
+    #
+    # ==== Example
+    #
+    #   create :label => 'myhv', :ip_address => '127.0.0.1', :hypervisor_type => 'xen'
+    def create(options = {})
+      params.required(:label, :ip_address, :hypervisor_type).validate!(options)
+      req = request(:post, '/settings/hypervisors.json', default_params(options))
+      req.first[1]
     end
 
-    def create(params = {})
-      required = { :ip_address, :label }
-      required_options!(required, params)
-      post(URI_PREFIX, { :hypervisor => params })
-      @response.code == 201
+    # Edit a Hypervisor
+    #
+    # ==== Options
+    #
+    # * +options+ - Params for editing the Hypervisor
+    # ==== Example
+    #
+    #   edit :label => 'myhv', :ip_address => '127.0.0.1'
+    def edit(id, options ={})
+      params.accepts(:label, :ip_address).validate!(options)
+      request(:put, "/settings/hypervisors/#{id}.json", default_params(options))
     end
 
-    def destroy(id)
-      delete("#{URI_PREFIX}/#{id}")
+    # Reboot a Hypervisor
+    def reboot(id)
+      response = request(:get, "/settings/hypervisors/#{id}/rebooting.json")
+      response['hypervisor']
     end
 
+    # Delete a Hypervisor
+    def delete(id)
+      req = request(:delete, "/settings/hypervisors/#{id}.json")
+    end
   end
 end

data/lib/squall/ip_address.rb

@@ -0,0 +1,13 @@
+module Squall
+  # OnApp IpAddress
+  class IpAddress < Base
+    # Returns a list of IpAddresses
+    #
+    # ==== Options
+    # * +network_id+ - required
+    def list(network_id)
+      response = request(:get, "/settings/networks/#{network_id}/ip_addresses.json")
+      response.collect { |ip| ip['ip_address'] }
+    end
+  end
+end

data/lib/squall/network.rb

@@ -0,0 +1,42 @@
+module Squall
+  # OnApp Network
+  class Network < Base
+    # Returns a list of Networks
+    def list
+      response = request(:get, '/settings/networks.json')
+      response.collect { |network| network['network'] }
+    end
+
+    # Edit a Network
+    #
+    # ==== Options
+    #
+    # * +options+ - Params for editing the Network
+    # ==== Example
+    #
+    #   edit :label => 'mynetwork', :network_group_id => 1, :vlan => 2, :identifier => 'something'
+    def edit(id, options = {})
+      params.accepts(:label, :network_group_id, :vlan, :identifier).validate!(options)
+      response = request(:put, "/settings/networks/#{id}.json", default_params(options))
+    end
+
+    # Create a Network
+    #
+    # ==== Options
+    #
+    # * +options+ - Params for creating the Network
+    # ==== Example
+    #
+    #   create :label => 'mynetwork', :network_group_id => 1, :vlan => 2, :identifier => 'something'
+    def create(options = {})
+      params.accepts(:label, :vlan, :identifier).required(:label).validate!(options)
+      response = request(:post, '/settings/networks.json', default_params(options))
+      response.first[1]
+    end
+
+    # Delete a network
+    def delete(id)
+      request(:delete, "/settings/networks/#{id}.json")
+    end
+  end
+end

data/lib/squall/params.rb

@@ -0,0 +1,50 @@
+module Squall
+  class Params
+    # Required
+    attr_accessor :valid
+
+    # Optional
+    attr_accessor :optional
+
+    def initialize
+      @valid    = []
+      @optional = []
+    end
+
+    def required(*options)
+      @valid = options.flatten.map { |o| o.to_sym}
+      @valid.uniq!
+      @optional.concat @valid
+      @optional.uniq!
+      self
+    end
+
+    def accepts(*options)
+      @optional.concat options.flatten.map { |o| o.to_sym}
+      @optional.uniq!
+      self
+    end
+
+    def validate!(*options)
+      validate_required!(*options) unless @valid.empty?
+      validate_optionals!(*options) unless @optional.empty?
+    end
+
+    def validate_required!(*options)
+      options = options.first.keys if options.first.respond_to?(:keys)
+      options.map! { |o| o.respond_to?(:to_sym) ? o.to_sym : o }
+      delta = (@valid - options)
+      raise ArgumentError, "Missing required params: #{delta.join(',')}" if delta.any?
+      true
+    end
+
+    def validate_optionals!(*options)
+      options = options.first.keys if options.first.respond_to?(:keys)
+      options.map! { |o| o.respond_to?(:to_sym) ? o.to_sym : o }
+      options.each do |key|
+        raise ArgumentError, "Unknown params: #{key}" unless @optional.include?(key)
+      end
+      true
+    end
+  end
+end

data/lib/squall/role.rb

@@ -0,0 +1,56 @@
+module Squall
+  # OnApp Role
+  class Role < Base
+    # Return a list of Roles
+    def list
+      response = request(:get, '/roles.json')
+      response.collect { |role| role['role']}
+    end
+
+    # Returns a Hash of the given Role
+    def show(id)
+      response = request(:get, "/roles/#{id}.json")
+      response.first[1]
+    end
+
+    # Edit a Role
+    #
+    # ==== Options
+    #
+    # * +options+ - Params for editing the Role
+    # ==== Example
+    #
+    #   edit :label => 'myrole', :permission => [1,3]
+    #   edit :label => 'myrole', :permission => 1
+    def edit(id, options = {})
+      params.accepts(:label, :permission).validate!(options)
+      response = request(:put, "/roles/#{id}.json", default_params(options))
+    end
+
+    # Delete a Role
+    def delete(id)
+      request(:delete, "/roles/#{id}.json")
+    end
+
+    # Returns a list of permissions available
+    def permissions
+      response = request(:get, '/permissions.json')
+      response.collect { |perm| perm['permission'] }
+    end
+
+    # Create a new Role
+    #
+    # ==== Options
+    #
+    # * +options+ - Params for creating the Role
+    #
+    # ==== Example
+    #
+    #   create :label => 'mypriv', :identifier => 'magic'
+    def create(options = {})
+      params.required(:label, :identifier).validate!(options)
+      response = request(:post, '/roles.json', default_params(options))
+      response.first[1]
+    end
+  end
+end